Variable: LixSchemaDefinition
const
LixSchemaDefinition: object
Type declaration
$schema
readonly
$schema: "http://json-schema.org/draft-07/schema#"
= "http://json-schema.org/draft-07/schema#"
allOf
readonly
allOf: readonly [{ $ref
: "http://json-schema.org/draft-07/schema#"
; }, { properties
: { properties
: { additionalProperties
: { allOf
: readonly [{ $ref
: "http://json-schema.org/draft-07/schema#"
; }, { properties
: { x-lix-generated
: { description
: "Whether this property is auto-generated by the database"
; type
: "boolean"
; }; }; type
: "object"
; }]; }; type
: "object"
; }; x-lix-foreign-keys
: { additionalProperties
: { properties
: { property
: { description
: "The property name in the referenced schema"
; type
: "string"
; }; schemaKey
: { description
: "The x-lix-key of the referenced schema"
; type
: "string"
; }; schemaVersion
: { description
: "Optional version of the referenced schema"
; pattern
: "^\d+\.\d+$"; type
: "string"
; }; }; required
: readonly ["schemaKey"
, "property"
]; type
: "object"
; }; type
: "object"
; }; x-lix-key
: { description
: "The key of the schema. The key is used to identify the schema. You must use a unique key for each schema."
; examples
: readonly ["csv_plugin_cell"
]; type
: "string"
; }; x-lix-unique
: { items
: { items
: { type
: "string"
; }; type
: "array"
; }; type
: "array"
; }; x-lix-version
: { description
: "The version of the schema. Use the major version to signal breaking changes. Use the minor version to signal non-breaking changes."
; examples
: readonly ["1.0"
]; pattern
: "^\d+\.\d+$"; type
: "string"
; }; x-primary-key
: { items
: { type
: "string"
; }; type
: "array"
; }; }; required
: readonly ["x-lix-key"
, "x-lix-version"
]; type
: "object"
; }]
description
readonly
description: "A JSON schema document that also includes custom x-key and x-version properties for identification and versioning."
= "A JSON schema document that also includes custom x-key and x-version properties for identification and versioning."
title
readonly
title: "Lix Change Schema"
= "Lix Change Schema"