Monkeybread Software - MBS FileMaker Plugin: ODBC Query

Components	All	New	MacOS		Windows		Linux		iOS
Examples	Mac & Win		Server	Client	Guides	Statistic	FMM	Blog	Deprecated	Old

MBS FileMaker Plugin Example Databases

ODBC Query

All examples are included with download of MBS FileMaker Plugin.

ODBC Query.fmp12

Overview
Tables	1
Relationships	0
Layouts	1
Scripts	5
Value Lists	0
Custom Functions	0
Custom Menus	33

File Options
Default custom menu set	[Standard FileMaker Menus]
When opening file
Minimum allowed version	12.0
Login using	Account Name; Account= Admin
Allow user to save password	Off
Require iOS passcode	Off
Switch to layout	Off
Hide all toolbars	Off
Script triggers
OnFirstWindowOpen	Off
OnLastWindowClose	Off
OnWindowOpen	Off
OnWindowClose	Off
OnFileAVPlayerChange	Off
Thumbnail Settings
Generate Thumbnails	On; Temporary

Tables

Table Name	Statistics	Occurrences in Relationship Graph
ODBC Query	6 fields defined, 11 records	ODBC Query

Fields

Table Name: ODBC Query - 6 Fields
Field Name	Type	Options	Comments	On Layouts	In Relationships	In Scripts	In Value Lists
SQL	Normal, Text	Auto-Enter: Allow editing Validation: Only during data entry Storage: Repetitions: 1 Indexing: None Automatically create indexes as needed Index Language: German		ODBC Query		RunQuery
Result	Normal, Text	Auto-Enter: Allow editing Validation: Only during data entry Storage: Repetitions: 1 Indexing: None Automatically create indexes as needed Index Language: German		ODBC Query		RunQuery
Username	Normal, Text	Auto-Enter: Allow editing Validation: Only during data entry Storage: Global Repetitions: 1 Index Language: German		ODBC Query		RunQuery
Password	Normal, Text	Auto-Enter: Allow editing Validation: Only during data entry Storage: Global Repetitions: 1 Index Language: German		ODBC Query		RunQuery
SQLConnectionString	Normal, Text	Auto-Enter: Allow editing Validation: Only during data entry Storage: Global Repetitions: 1 Index Language: German		ODBC Query		RunQuery
PathToLibrary	Normal, Text	Auto-Enter: Allow editing Validation: Only during data entry Storage: Global Repetitions: 1 Index Language: German		ODBC Query		RunQuery

Layout Objects: ODBC Query

Regular Fields

Field Name: ODBC Query::SQL

Layout Name:

ODBC Query

Top: 96 pt
Left: 138 pt
Bottom: 110 pt
Right: 553 pt

Anchoring: Left, Top

Field Format:

Edit Box

Field Behavior:

Allow field to be entered: In Find mode, In Browse mode
Touch keyboard type: System Default
Go to next field using: Tab key

Yes

Field Name: ODBC Query::Result

Layout Name:

ODBC Query

Top: 114 pt
Left: 138 pt
Bottom: 320 pt
Right: 553 pt

Anchoring: Left, Top

Field Format:

Edit Box

Field Behavior:

Allow field to be entered: In Find mode, In Browse mode
Touch keyboard type: System Default
Go to next field using: Tab key

Yes

Field Name: ODBC Query::Username

Layout Name:

ODBC Query

Top: 18 pt
Left: 138 pt
Bottom: 32 pt
Right: 391 pt

Anchoring: Left, Top

Field Format:

Edit Box

Field Behavior:

Allow field to be entered: In Find mode, In Browse mode
Touch keyboard type: System Default
Go to next field using: Tab key

Field Name: ODBC Query::Password

Layout Name:

ODBC Query

Top: 36 pt
Left: 138 pt
Bottom: 50 pt
Right: 391 pt

Anchoring: Left, Top

Field Format:

Edit Box

Field Behavior:

Allow field to be entered: In Find mode, In Browse mode
Touch keyboard type: System Default
Go to next field using: Tab key

Field Name: ODBC Query::SQLConnectionString

Layout Name:

ODBC Query

Top: 54 pt
Left: 138 pt
Bottom: 68 pt
Right: 391 pt

Anchoring: Left, Top

Field Format:

Edit Box

Field Behavior:

Allow field to be entered: In Find mode, In Browse mode
Touch keyboard type: System Default
Go to next field using: Tab key

Field Name: ODBC Query::PathToLibrary

Layout Name:

ODBC Query

Top: 72 pt
Left: 138 pt
Bottom: 86 pt
Right: 391 pt

Anchoring: Left, Top

Field Format:

Edit Box

Field Behavior:

Allow field to be entered: In Find mode, In Browse mode
Touch keyboard type: System Default
Go to next field using: Tab key

Type:

Text: Run Query

Layout Name:

ODBC Query

Additional Properties:

Change to hand cursor over button
Rectangular

Top: 24 pt
Left: 414 pt
Bottom: 49 pt
Right: 493 pt

Anchoring: Left, Top

Perform Script [ “RunQuery” ]

Scripts:

RunQuery

Script Hierarchy

RunQuery

get json

get json with error handling

copy records from SQL Server to FileMaker

copy records from FileMaker to SQL Server

Next Script: [get json]

Script Name	RunQuery
Run script with full access privileges	Off
Include In Menu	Yes
Layouts that use this script	ODBC Query
Scripts that use this script
Script Definition
Script Steps	Set Variable [ $r; Value:MBS("Trace") ] Set Variable [ $Connection; Value:MBS("SQL.NewConnection") ] #Tell plugin where MySQL library is If [ Length(ODBC Query::PathToLibrary) > 0 ] Set Variable [ $result; Value:MBS("SQL.SetConnectionOption"; $Connection; "ODBC.LIBS"; ODBC Query::PathToLibrary) ] End If #Tell plugin we want to use ODBC Set Variable [ $result; Value:MBS("SQL.SetClient"; $Connection; "ODBC") ] #Connect to database in read/write/create mode. Creates new file if none exists. Set Variable [ $result; Value:MBS("SQL.Connect"; $Connection; ODBC Query::SQLConnectionString; ODBC Query::Username; ODBC Query::Password; "ODBC") ] If [ $result ≠ "OK" ] Show Custom Dialog [ Message: "Error: " & $result; Default Button: “OK”, Commit: “No”; Button 2: “Abbrechen”, Commit: “No” ] Set Variable [ $result; Value:MBS("SQL.FreeConnection"; $Connection) ] Halt Script End If #Create select and run it Set Variable [ $Command; Value:MBS("SQL.NewCommand"; $Connection; ODBC Query::SQL) ] #Run it Set Variable [ $result; Value:MBS("SQL.Execute"; $Command) ] If [ $result ≠ "OK" ] Set Field [ ODBC Query::Result; $result ] Show Custom Dialog [ Message: "Error: " & $result; Default Button: “OK”, Commit: “No”; Button 2: “Abbrechen”, Commit: “No” ] Else Set Variable [ $lines; Value:"" ] Set Variable [ $fieldcount; Value:MBS("SQL.FieldCount"; $command) ] Loop Set Variable [ $result; Value:MBS("SQL.FetchNext"; $Command) ] Exit Loop If [ $result ≠ 1 ] Set Variable [ $line; Value:"" ] Set Variable [ $i; Value:1 ] Loop Set Variable [ $v; Value:MBS("SQL.GetFieldAsText"; $command; $i) ] Set Variable [ $n; Value:MBS("SQL.GetFieldName"; $command; $i) ] Set Variable [ $line; Value:$line & $n & ": " & $v & ¶ ] Set Variable [ $i; Value:$i+1 ] Exit Loop If [ $i > $fieldCount ] End Loop Set Variable [ $lines; Value:$lines & ($line & ¶) ] End Loop Set Variable [ $lines; Value:$lines & ¶ ] Set Field [ ODBC Query::Result; $lines ] End If #Cleanup Set Variable [ $result2; Value:MBS("SQL.FreeCommand"; $Command) ] Set Variable [ $result2; Value:MBS("SQL.FreeConnection"; $Connection) ]
Fields used in this script	ODBC Query::PathToLibrary ODBC Query::SQLConnectionString ODBC Query::Username ODBC Query::Password ODBC Query::SQL ODBC Query::Result
Scripts used in this script
Layouts used in this script
Tables used in this script	ODBC Query
Table occurrences used by this script	ODBC Query
Custom Functions used by this script
Custom menu set used by this script

Previous Script: [RunQuery]

Next Script: [get json with error handling]

Script Name	get json
Run script with full access privileges	Off
Include In Menu	Yes
Layouts that use this script
Scripts that use this script
Script Definition
Script Steps	#connect to ODBC data source named "Test" Set Variable [ $Connection; Value:MBS("SQL.NewConnection") ] Set Variable [ $r; Value:MBS("SQL.Connect"; $Connection; "test"; ""; ""; "ODBC") ] #run SQL query Set Variable [ $Command; Value:MBS("SQL.NewCommand"; $Connection; "SELECT * FROM MyTable") ] Set Variable [ $r; Value:MBS("SQL.Execute"; $Command) ] #get JSON records Set Variable [ $$json; Value:MBS( "SQL.GetRecordsAsJSON"; $Command ) ] #cleanup Set Variable [ $r; Value:MBS("SQL.FreeCommand"; $Command) ] Set Variable [ $r; Value:MBS("SQL.FreeConnection"; $Connection) ]
Fields used in this script
Scripts used in this script
Layouts used in this script
Tables used in this script
Table occurrences used by this script
Custom Functions used by this script
Custom menu set used by this script

Previous Script: [get json]

Next Script: [copy records from SQL Server to FileMaker]

Script Name	get json with error handling
Run script with full access privileges	Off
Include In Menu	Yes
Layouts that use this script
Scripts that use this script
Script Definition
Script Steps	#connect to ODBC data source named "Test" Set Variable [ $Connection; Value:MBS("SQL.NewConnection") ] Set Variable [ $r; Value:MBS("SQL.Connect"; $Connection; "test"; ""; ""; "ODBC") ] If [ MBS("IsError") ≠ 0 ] Show Custom Dialog [ Title: "Failed to connect"; Message: $r; Default Button: “OK”, Commit: “No”; Button 2: “Abbrechen”, Commit: “No” ] Else #run SQL query Set Variable [ $Command; Value:MBS("SQL.NewCommand"; $Connection; "SELECT * FROM MyTable") ] If [ MBS("IsError") ≠ 0 ] Show Custom Dialog [ Title: "Failed to parse SQL"; Message: $command; Default Button: “OK”, Commit: “No”; Button 2: “Abbrechen”, Commit: “No” ] Else Set Variable [ $r; Value:MBS("SQL.Execute"; $Command) ] If [ MBS("IsError") ≠ 0 ] Show Custom Dialog [ Title: "Failed to execute SQL"; Message: $r; Default Button: “OK”, Commit: “No”; Button 2: “Abbrechen”, Commit: “No” ] Else #get JSON records Set Variable [ $$json; Value:MBS( "SQL.GetRecordsAsJSON"; $Command ) ] End If #cleanup Set Variable [ $r; Value:MBS("SQL.FreeCommand"; $Command) ] End If End If Set Variable [ $r; Value:MBS("SQL.FreeConnection"; $Connection) ]
Fields used in this script
Scripts used in this script
Layouts used in this script
Tables used in this script
Table occurrences used by this script
Custom Functions used by this script
Custom menu set used by this script

Previous Script: [get json with error handling]

Next Script: [copy records from FileMaker to SQL Server]

Script Name	copy records from SQL Server to FileMaker
Run script with full access privileges	Off
Include In Menu	Yes
Layouts that use this script
Scripts that use this script
Script Definition
Script Steps	#connect to ODBC data source named "Test" Set Variable [ $Connection; Value:MBS("SQL.NewConnection") ] Set Variable [ $r; Value:MBS("SQL.Connect"; $Connection; "test"; ""; ""; "ODBC") ] #run SQL query Set Variable [ $Command; Value:MBS("SQL.NewCommand"; $Connection; "SELECT FirstName, LastName, CityName, 123 FROM MyTable") ] Set Variable [ $r; Value:MBS("SQL.Execute"; $Command) ] #insert records to FileMaker Set Variable [ $FieldNames; Value:"FirstName¶LastName¶City¶ImportID" ] Set Variable [ $r; Value:MBS( "SQL.InsertRecords"; $Command; Get(FileName ); "Import" /* target table in FileMaker */; $FieldNames) ] #cleanup Set Variable [ $r; Value:MBS("SQL.FreeCommand"; $Command) ] Set Variable [ $r; Value:MBS("SQL.FreeConnection"; $Connection) ]
Fields used in this script
Scripts used in this script
Layouts used in this script
Tables used in this script
Table occurrences used by this script
Custom Functions used by this script
Custom menu set used by this script

Previous Script: [copy records from SQL Server to FileMaker]

Script Name	copy records from FileMaker to SQL Server
Run script with full access privileges	Off
Include In Menu	Yes
Layouts that use this script
Scripts that use this script
Script Definition
Script Steps	#connect to ODBC data source named "Test" Set Variable [ $Connection; Value:MBS("SQL.NewConnection") ] Set Variable [ $r; Value:MBS("SQL.Connect"; $Connection; "test"; ""; ""; "ODBC") ] #run SQL query in FileMaker Set Variable [ $Records; Value:MBS( "FM.SQL.Execute"; Get(FileName); "SELECT FirstName, LastName, \"City Name\" FROM Import") ] #insert records to SQL database Set Variable [ $FieldNames; Value:"FirstName¶LastName¶City" ] Set Variable [ $r; Value:MBS( "FM.SQL.InsertRecordsToSQL"; $Records; $Connection; "Export" /* target table in SQL */; $FieldNames) ] #cleanup Set Variable [ $r; Value:MBS("FM.SQL.Release"; $Records) ] Set Variable [ $r; Value:MBS("SQL.FreeConnection"; $Connection) ]
Fields used in this script
Scripts used in this script
Layouts used in this script
Tables used in this script
Table occurrences used by this script
Custom Functions used by this script
Custom menu set used by this script

Download example: ODBC Query

Used functions: