Methods
The following methods are available for all adapters.
listreturn all records from a given layoutfindperform a FileMaker findgetreturn a single record by recordIDcreatereturn a new recordupdatemodify a single record by recordIDdeletedelete a single record by recordID
Helper Functions
This package also includes some helper methods to make working with Data API responses a little easier:
findOnereturn the first record from a find instead of an array. This method will error unless exactly 1 record is found.findFirstreturn the first record from a find instead of an array, but will not error if multiple records are found.findAllreturn all found records from a find, automatically handling pagination. Use caution with large datasets!listAllreturn all records from a given layout, automatically handling pagination. Use caution with large datasets!
Adapter-Specific Functions
The first-party FetchAdapter and OttoAdatper both share the following additional methods from the BaseFetchAdapter:
executeScriptexecute a FileMaker script directlylayoutMetadatareturn metadata for a given layoutlayoutsreturn a list of all layouts in the database (top-level layout key ignored)scriptsreturn a list of all scripts in the database (top-level script key ignored)globalsset global fields for the current session (top-level globals key ignored)
If you have your own proxy, you can write your own Custom Adapter that extends the BaseFetchAdapter to also implement these methods.
Fetch Adapter
disconnectforcibly logout of your FileMaker session
Otto Adapter
No additional methods
