Getting started

go-filemaker is a simple Go (Golang) wrapper for the FileMaker Data API, inspired by the FileMaker PHP API. It's been tested and verified to work with FileMaker Server 18 and 19.

Getting started

Installation

go mod init github.com/my/repo
go get github.com/MjukBiltvatt/go-filemaker/v3

Importing

import "github.com/MjukBiltvatt/go-filemaker/v3"

Quickstart

By default the returned records limit is 100. This can however be controlled with Limit.

//Create a session
fm, err := filemaker.New(
  "https://my.host.com",
  "database",
  "username",
  "password",
)
if err != nil {
  fmt.Printf("Failed to start session: %s", err.Error())
  return
}
//Destroy the session when we're done with it
defer fm.Destroy()

//Perform find command
records, err := fm.Find(
  "layoutname",
  filemaker.NewFindCommand(
    filemaker.NewFindRequest(
      filemaker.NewFindCriterion("Firstname", "Mark"),
      filemaker.NewFindCriterion("HasCat", ".."),
      filemaker.NewFindCriterion("Age", "*"),
    ),
    filemaker.NewFindRequest(
      filemaker.NewFindCriterion("Lastname", "==Johnson"),
    ).Omit()
  ).Limit(10)
)
if err != nil {
  fmt.Printf("Failed to perform find: %s", err.Error())
  return
}

//Evaluate result
if len(records) > 0 {
  for _, record := range records {
    fmt.Printf(
      "%s is %d years old.",
      record.String("Firstname"),
      record.Int("Age"),
    )
  }
} else {
  fmt.Println("No records found")
}

FindCommand

While being able to pass findrequests into the NewFindCommand method, they can also be added to the findcommand after instantiation.

By default the limit is 100.

command := filemaker.NewFindCommand()
command.AddRequest(request)

FindRequest

While being able to pass findcriterions into the NewFindRequest method, they can also be added to the findrequest after instantiation.

request := filemaker.NewFindRequest()
request.AddCriterion(criterion)

Omit

Omit any records that match the find request.

command := filemaker.NewFindCommand(
  filemaker.NewFindRequest(
    filemaker.NewFindCriterion("field name", "somethinglikethis"),
  ),
  filemaker.NewFindRequest(
    filemaker.NewFindCriterion("other field name", "notsomethinglikethis"),
  ).Omit(), //Omit request
)

Limit

Will limit the number of records returned from a find command.

By default the limit is 100.

command := filemaker.NewFindCommand(
  //...
).Limit(10)

Offset

Will offset the records returned from a find command.

command := filemaker.NewFindCommand(
  //...
).Offset(10)

Sorting

Sort the result by the specified field and order.

//Ascending sort order
findCommand.Sort("FieldName", filemaker.SortAscending)

//Descending sort order
findCommand.Sort("FieldName", filemaker.SortDescending)

Chaining (limit, offset, sort)

These can be chained, allowing them to be used directly in the Find method.

records, err := fm.Find(
  "layout name",
  filemaker.NewFindCommand(
    //...
  ).Limit(10).Offset(10).Sort("Firstname", filemaker.SortAscending)
)

Records

Create

//Create a new empty record for the specified layout
record := fm.NewRecord("layout name")

//Set field data
record.Set("field name", "data")

//Create the record
err := record.Commit()

//Record now contains an ID after committing
fmt.Printf("Record ID: %v", record.ID)

Edit

//Set field data
record.Set("field name", "new data")

//Commit changes
err := record.Commit()

Revert uncommitted changes

//Set field data
record.Set("field name", "new data")

//Reset the record
record.Reset()

fmt.Println(record.String("field name"))
//Output: original data

Delete

err := record.Delete()

Commit file or byte buffer to container field

Container fields are a little bit different from normal fields, so we can't simply set the container field data and commit it with the rest of the record data. We instead need to commit the container field data seperately. The record must already be committed or be the result of a find command. An error will be returned if attempting this before committing a newly created record.

//Commit a byte buffer
err := record.CommitToContainer("field name", "filename.pdf", buf)

//Commit a file, the contents will be copied
err := record.CommitFileToContainer("field name", "/path/to/my/file.pdf")

Get field data