Advanced Settings

Enabling extra features in settings field allows you to generate additional GraphQL queries. These features include:

• Aggregating values
• Bulk upsert
• Plural form for uncountable nouns
• Store data as a draft
• Tailor DB Change Data Capture(CDC) - Publish record events for database triggers

Below is a table listing all the available settings, with each field and its corresponding type.

Also, we can utilize the following advanced GraphQL schema configuration to optimize GraphQL queries.

• Directives
• Extends

Directives

Directive is a GraphQL concept, that provides a way to add additional instructions to GraphQL queries without having to modify the schema. This allows developers to use GraphQL to access the same data in different ways without having to change the underlying data structure. The Directives field holds a map structure data, where the key is directive name and the value is a map of arguments defined in the Args key.

For example, we can define the directive of @key(fields: "id") as the following:

// enable directives
directives = [
  {
    name = "key"
    args = [
      {
        name  = "fields"
        value = "id"
      }
    ]
  }
]

// enable directives
Directives:  [{
  Name: "key"
  Args: [
    {
      name:  "fields"
      value: "id"
    },
  ]
}]

See GraphQL Directives for more details.

Extends

The Extends option enables the extension of the types defined in other sub-graphs, like StateFlow. With this option enabled, CRUD GraphQL queries become available in Tailor DB. To make this work, the directive of @key(fields: "id") must be defined.

For example, if we want to extend State resource in StateFlow, we can define the extend and directives in the schema as follows: This will generate createExtendState, updateExtendState, deleteExtendState, and changeExtendState API.

// example of state.tf enabling extends
resource "tailor_tailordb_type" "state" {
  workspace_id = tailor_workspace.ims.id
  namespace    = tailor_tailordb.ims.namespace
  name         = "State"

  // Set true for extends setting
  extends = true

  // You must define @key(fields: "id") directive as follows
  directives = [{
    name = "key"
    args = [
      {
        name  = "fields"
        value = "id"
      }
    ]
  }]
}

// example of state.cue enabling extends
State: tailordb.#Type & {
  // ...
  // Set true for extends setting
  Extends: true
  // You must define @key(fields: "id") directive as follows
  Directives:  [{
    Name: "key"
    Args: [
      {
        name:  "fields"
        value: "id"
      },
    ]
  }]
}