SQL (Preview)

On This Page

Properties
Example

The Preview version of Forge SQL currently does not support data residency. By using Forge SQL, you acknowledge that Section 6 (Data Residency) of the Forge Terms does not apply to data stored using Forge SQL, and you must not use Forge SQL for any applications that require data residency. For more details, please see the Data residency limitations section.

Use the sql module to enable the Forge SQL capability. You can only define this module once per app.

See Forge SQL for detailed information about implementing this capability.

Adding the sql module to your manifest will trigger a major version upgrade. See Versioning for more details.

The trigger module invokes a function or calls a remote backend when a product event, app lifecycle event, or data security policy event is fired. For example, as the result of an issue being created in Jira.

Properties

Property Type Required Description

Property	Type	Required	Description
`key`	`string`	Yes	A key for the module, which other modules can refer to. Must be unique within the manifest. Regex: `^[a-zA-Z0-9_-]+$`
`engine`	`enum`	Yes	Specifies which Forge SQL engine your app uses. For now, the only supported value is `mysql`.

key

string

Yes

A key for the module, which other modules can refer to. Must be unique within the manifest.

Regex: ^[a-zA-Z0-9_-]+$

engine enum Yes Specifies which Forge SQL engine your app uses. For now, the only supported value is mysql.

Example

1
2
modules:
  sql:
    - key: main
      engine: mysql