Skip to content

Latest commit

 

History

History
71 lines (66 loc) · 3.23 KB

join-schema.md

File metadata and controls

71 lines (66 loc) · 3.23 KB
Raw

Join config

Configuration for joining tables.

Properties

  • consistency (string): Consistency level. Immediate applies at the end of the command. Deferred applies at the end of a transaction. Must be one of: ['deferred', 'immediate']. Default: immedidate.
  • context (array): PostgreSQL settings to propogate through async joins. Default: [].
    • Items (string)
  • id (string): ID for name mangling created objects.
  • lock (boolean): Whether to lock before refreshing target. Default: False.
  • key (['array', 'null']): Key. If null, uses values from targetTable. Default: None.
  • setup: Setup function. Refer to #/definitions/hook. Default: None.
  • schema (string): Schema for created objects. If not set, the default schema is used. Default: None.
  • tables (object): Map from ID to table. Can contain additional properties.
  • targetQuery (['string', 'null']): Query to populate the target table. Default: TABLE ${key}.
  • targetTable: Refer to #/definitions/targetTable.

Definitions

  • column: Column.
    • name (string): Name of column.
    • value (['null', 'string']): SQL expression. If null, the column value is used. Default: None.
  • keyColumn: Column.
    • name (string): Name of column.
    • type (['null', 'string']): Type of column. Default: None.
    • value (['null', 'string']): SQL expression. If null, the column value is used. Default: None.
  • table (object): Source table. Cannot contain additional properties.
    • columns (['null', 'array']): Columns to select from table. Default: None.
      • Items: Refer to #/definitions/column.
    • lockId (['integer', 'null']): Advisory lock space to use for queueing. If null, it is generated from the ID and table ID. Minimum: -32678. Maximum: 32677. Default: None.
    • join (['string', 'null']): IDs of dependency table. Default: None.
    • joinKey (['array', 'null']): Unique key for foreign table. Default: None.
      • Items (string)
    • joinMode (['string', 'null']): Mode of dependency join. Must be one of: ['async', 'sync']. Default: sync.
    • joinOther (['string', 'null']): Expressions to add to join. Default: None.
    • joinOn (['string', 'null']): SQL expression to join to dependency. Default: None.
    • key (['array', 'null']): Unique key. Default: None.
      • Items: Refer to #/definitions/keyColumn.
    • name (string): Name of table.
    • refreshFunction (boolean): Whether to generate a refresh function. Default: False.
    • schema (string): Name of schema. Default: None.
    • targetKey (['array', 'null']): SQL expressions for target key values. Default: None.
      • Items (string)
  • targetTable: Target table.
    • columns (['array', 'null']): Columns. Default: None.
      • Items (string)
    • key (['array', 'null']): Key columns. Default: None.
      • Items (string)
    • schema (string): Schema of table. If null, the table is not schema-qualified. Default: None.
    • name (string): Name of table.