schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
sdf-schema-1.1.json
repository
The URL of the workspace source repository [defaults to 'none' if no repository is given]
{"type": ["string", "null"]}
sdf-schema-1.1.json
remote-location
The default output object store location, e.g. 's3://bucket/key/' where key is optional
{"type": ["string", "null"]}
sdf-schema-1.1.json
includes
An array of directories and filenames containing .sql and .sdf.yml files
{"type": ["array", "null"], "items": {}}
sdf-schema-1.1.json
excludes
An array of directories and filenames to be skipped when resolving includes
{"type": ["array", "null"], "items": {}}
sdf-schema-1.1.json
references
An array of paths to other workspaces, i.e. .sql and .yml files
{"writeOnly": true, "type": ["array", "null"], "items": {}}
sdf-schema-1.1.json
dialect
The dialect of this workspace. If not set, defaults to sdf dialect
{"anyOf": [{}, {"type": "null"}]}
sdf-schema-1.1.json
resources
An array of paths to directories and files, which will be copied to the SDF service on deployment
{"type": ["array", "null"], "items": {}}
sdf-schema-1.1.json
default-catalog
Defines a default catalog [If not set, defaults to the directory of the workspace]
{"type": ["string", "null"]}
sdf-schema-1.1.json
default-schema
Defines a default schema [If not set, defaults to 'pub']
{"type": ["string", "null"]}
sdf-schema-1.1.json
default-profile
Defines the default profile [if not set, defaults to 'dbg']
{"type": ["string", "null"]}
sdf-schema-1.1.json
source-locations
Workspace defined by these set of files
{"anyOf": [{}, {"type": "null"}]}
sdf-schema-1.1.json
variables
An array of named values for setting SQL variables from your environment Ex. -dt: dt, used in SQL as @dt
{"type": ["array", "null"], "items": {}}
sdf-schema-1.1.json
code-reports
An array of queries over the information schema that will be run on sdf describe and sdf deploy
{"type": ["array", "null"], "items": {}}
sdf-schema-1.1.json
code-checks
An array of queries over the information schema that will be run on sdf describe and sdf deploy
{"type": ["array", "null"], "items": {}}
sdf-schema-1.1.json
access-control
An array of attribute based access control queries over the information schema, current user and current job, that will be run on sdf build and sdf deploy
{"type": ["array", "null"], "items": {}}
sdf-schema-1.1.json
IncludePath
All file path should either be relative to the workspace, or absolute for an object store like AWS s3:// Note that an [IncludePath] specifies a catalog and schema scope for unqualified names (in effect for both creating and querying tables). See [IncludePath::default_catalog] and [IncludePath::default_schema].
{"type": "object", "required": ["path"], "properties": {"path": {"type": "string"}, "default-catalog": {"type": ["string", "null"]}, "default-schema": {"type": ["string", "null"]}, "dialect": {"anyOf": [{}, {"type": "null"}]}, "time": {"writeOnly": true, "anyOf": [{}, {"type": "null"}]}}, "additionalProperties": false}
sdf-schema-1.1.json
path
A filepath
{"type": "string"}
sdf-schema-1.1.json
default-catalog
Defines a default catalog for unqualified names. If not set, defaults to the [Workspace] catalog.
{"type": ["string", "null"]}
sdf-schema-1.1.json
default-schema
Defines a default schema for unqualified names. If not set, defaults to the [Workspace] schema.
{"type": ["string", "null"]}
sdf-schema-1.1.json
dialect
The dialect of the included files. If not set, defaults to the [Workspace] dialect.
{"anyOf": [{}, {"type": "null"}]}
sdf-schema-1.1.json
time
Last modified of the file
{"writeOnly": true, "anyOf": [{}, {"type": "null"}]}
sdf-schema-1.1.json
FilePath
All file path should either be relative to the workspace, or absolute for an object store like AWS s3://
{"type": "object", "required": ["path"], "properties": {"path": {"type": "string"}, "time": {"writeOnly": true, "anyOf": [{}, {"type": "null"}]}}, "additionalProperties": false}
sdf-schema-1.1.json
path
A filepath
{"type": "string"}
sdf-schema-1.1.json
time
Last modified of the file
{"writeOnly": true, "anyOf": [{}, {"type": "null"}]}
sdf-schema-1.1.json
path
The relative path from this workspace to the referenced workspace, for a Git repo, from the root of the depot to the workspace
{"type": "string"}
sdf-schema-1.1.json
git
The Git repo
{"type": "string"}
sdf-schema-1.1.json
rev
the Git revision
{"type": "string"}
sdf-schema-1.1.json
branch
the Git branch
{"type": "string"}
sdf-schema-1.1.json
Variable
SQL queries can be parameterized via variables of type varchar. A variable definition binds the variable to the provided value.
{"type": "object", "required": ["name"], "properties": {"name": {"type": "string"}, "value": {"type": ["string", "null"]}}, "additionalProperties": false}
sdf-schema-1.1.json
name
The name of the variable
{"type": "string"}
sdf-schema-1.1.json
value
The value of this variable (using sql/yaml literals)
{"type": ["string", "null"]}
sdf-schema-1.1.json
path
A filepath
{"type": "string"}
sdf-schema-1.1.json
name
Name of check (default filestem of path)
{"type": "string"}
sdf-schema-1.1.json
description
A description of this report
{"type": ["string", "null"]}
sdf-schema-1.1.json
dialect
dialect
{"anyOf": [{}, {"type": "null"}]}
sdf-schema-1.1.json
assert
Assertion
{"allOf": [{}]}
sdf-schema-1.1.json
name
Name of check (default filestem of path)
{"type": ["string", "null"]}
sdf-schema-1.1.json
path
A filepath
{"type": "string"}
sdf-schema-1.1.json
description
A description of this assertion
{"type": ["string", "null"]}
sdf-schema-1.1.json
dialect
dialect
{"anyOf": [{}, {"type": "null"}]}
sdf-schema-1.1.json
access
Grant access
{"allOf": [{}]}
sdf-schema-1.1.json
name
Name of check (default filestem of path)
{"type": "string"}
sdf-schema-1.1.json
description
A description of this access control rule
{"type": ["string", "null"]}
sdf-schema-1.1.json
path
A filepath to a policy authored in .sql
{"type": "string"}
sdf-schema-1.1.json
Profile
Profiles provide a way to override the fields of a workspace, i.e. if a profile has set field X, then the workspace field X will be overridden by the profile field X.
{"type": "object", "required": ["name"], "properties": {"name": {"type": "string"}, "remote-location": {"type": ["string", "null"]}, "includes": {"type": ["array", "null"], "items": {}}, "excludes": {"type": ["array", "null"], "items": {}}, "references": {"writeOnly": true, "type": ["array", "null"], "items": {}}, "dialect": {"anyOf": [{}, {"type": "null"}]}, "resources": {"type": ["array", "null"], "items": {}}, "default-catalog": {"type": ["string", "null"]}, "default-schema": {"type": ["string", "null"]}, "source-locations": {"anyOf": [{}, {"type": "null"}]}, "variables": {"type": ["array", "null"], "items": {}}, "code-reports": {"type": ["array", "null"], "items": {}}, "code-checks": {"type": ["array", "null"], "items": {}}, "access-control": {"type": ["array", "null"], "items": {}}}, "additionalProperties": false}
sdf-schema-1.1.json
description
A description of this workspace
{"type": ["string", "null"]}
sdf-schema-1.1.json
remote-location
The default output object store location, e.g. 's3://bucket/key/' where key is optional
{"type": ["string", "null"]}
sdf-schema-1.1.json
includes
An array of directories and filenames containing .sql and .sdf.yml files
{"type": ["array", "null"], "items": {}}
sdf-schema-1.1.json
excludes
An array of directories and filenames to be skipped when resolving includes
{"type": ["array", "null"], "items": {}}
sdf-schema-1.1.json
references
An array of paths to other workspaces, i.e. .sql and .yml files
{"writeOnly": true, "type": ["array", "null"], "items": {}}
sdf-schema-1.1.json
dialect
The default dialect of this workspace. If not set, defaults to sdf dialect
{"anyOf": [{}, {"type": "null"}]}
sdf-schema-1.1.json
resources
An array of paths to directories and files, which will be copied to the SDF service on deployment
{"type": ["array", "null"], "items": {}}
sdf-schema-1.1.json
default-catalog
Defines a default catalog [If not set, defaults to the directory of the workspace]
{"type": ["string", "null"]}
sdf-schema-1.1.json
default-schema
Defines a default schema [If not set, defaults to 'pub']
{"type": ["string", "null"]}
sdf-schema-1.1.json
source-locations
Workspace defined by these set of files
{"anyOf": [{}, {"type": "null"}]}
sdf-schema-1.1.json
variables
An array of named values for setting SQL variables from your environment Ex. -dt: dt, used in SQL as @dt
{"type": ["array", "null"], "items": {}}
sdf-schema-1.1.json
code-reports
An array of queries over the information schema that will be run on sdf describe and sdf deploy
{"type": ["array", "null"], "items": {}}
sdf-schema-1.1.json
code-checks
An array of queries over the information schema that will be run on sdf describe and sdf deploy
{"type": ["array", "null"], "items": {}}
sdf-schema-1.1.json
access-control
An array of attribute based access control queries over the information schema, current user and current job, that will be run on sdf build and sdf deploy
{"type": ["array", "null"], "items": {}}
sdf-schema-1.1.json
Table
A tables is either defined by given data (also called external table) or defined via a query.
{"type": "object", "required": ["name"], "properties": {"name": {"type": "string"}, "dialect": {"anyOf": [{}, {"type": "null"}]}, "dependencies": {"type": ["array", "null"], "items": {"type": "string"}}, "columns": {"type": ["array", "null"], "items": {}}, "partitioned-by": {"type": ["array", "null"], "items": {}}, "schedule": {"type": ["string", "null"]}, "starting": {"type": ["string", "null"]}, "classifiers": {"type": ["array", "null"], "items": {"type": "string"}}, "reclassify": {"type": ["array", "null"], "items": {}}, "lineage": {"anyOf": [{}, {"type": "null"}]}, "materialization": {"anyOf": [{}, {"type": "null"}]}, "insert-into": {"type": ["string", "null"]}, "location": {"type": ["string", "null"]}, "file-format": {"anyOf": [{}, {"type": "null"}]}, "with-header": {"type": ["boolean", "null"]}, "delimiter": {"type": ["string", "null"]}, "compression": {"anyOf": [{}, {"type": "null"}]}, "source-locations": {"type": ["array", "null"], "items": {}}}, "additionalProperties": false}
sdf-schema-1.1.json
dialect
An array of sql file names [Typically inferred]
{"anyOf": [{}, {"type": "null"}]}
sdf-schema-1.1.json
dependencies
ALl table dependencies (syntax: catalog.schema.table)
{"type": ["array", "null"], "items": {"type": "string"}}
sdf-schema-1.1.json
columns
The columns of the schema: name, type, metadata
{"type": ["array", "null"], "items": {}}
sdf-schema-1.1.json
partitioned-by
The partitioning format of the table
{"type": ["array", "null"], "items": {}}
sdf-schema-1.1.json
schedule
The schedule of the table [expressed as cron]
{"type": ["string", "null"]}
sdf-schema-1.1.json
starting
The first date of the table [expressed by prefixes of RFC 33]
{"type": ["string", "null"]}
sdf-schema-1.1.json
classifiers
An array of classifier references
{"type": ["array", "null"], "items": {"type": "string"}}
sdf-schema-1.1.json
reclassify
Array of reclassify instructions for changing the attached classifier labels
{"type": ["array", "null"], "items": {}}
sdf-schema-1.1.json
lineage
Lineage, a tagged array of column references
{"anyOf": [{}, {"type": "null"}]}
sdf-schema-1.1.json
materialization
The materialization scheme of this table
{"anyOf": [{}, {"type": "null"}]}
sdf-schema-1.1.json
insert-into
Store data under this catalog.schema.table instead of the original name
{"type": ["string", "null"]}
sdf-schema-1.1.json
location
Data is at this location
{"type": ["string", "null"]}
sdf-schema-1.1.json
file-format
Store table in this format [only for external tables]
{"anyOf": [{}, {"type": "null"}]}
sdf-schema-1.1.json
with-header
CSV data has a header [only for external tables]
{"type": ["boolean", "null"]}
sdf-schema-1.1.json
delimiter
CSV data is separated by this delimiter [only for external tables]
{"type": ["string", "null"]}
sdf-schema-1.1.json
compression
Json or CSV data is compressed with this method [only for external tables]
{"anyOf": [{}, {"type": "null"}]}
sdf-schema-1.1.json
source-locations
Table is defined by these .sql and/or .sdf files
{"type": ["array", "null"], "items": {}}
sdf-schema-1.1.json
name
The name of the column
{"type": "string"}
sdf-schema-1.1.json
description
A description of this column
{"type": ["string", "null"]}
sdf-schema-1.1.json
datatype
The type of this column
{"type": ["string", "null"]}
sdf-schema-1.1.json
nullable
The type of this column
{"type": ["boolean", "null"]}
sdf-schema-1.1.json
classifiers
An array of classifier references
{"type": ["array", "null"], "items": {"type": "string"}}
sdf-schema-1.1.json
lineage
Lineage, a tagged array of column references
{"anyOf": [{}, {"type": "null"}]}
sdf-schema-1.1.json
reclassify
Array of reclassify instructions for changing the attached classifier labels
{"type": ["array", "null"], "items": {}}
sdf-schema-1.1.json
copy
The output column is computed by copying these upstream columns
{"type": ["array", "null"], "items": {"type": "string"}}
sdf-schema-1.1.json
modify
The output column is computed by transforming these upstream columns
{"type": ["array", "null"], "items": {"type": "string"}}
sdf-schema-1.1.json
scan
These upstream columns are indirectly used to produce the output (e.g. in WHERE or GROUP BY)
{"type": ["array", "null"], "items": {"type": "string"}}
sdf-schema-1.1.json
apply
These functions were used to produce the output column
{"type": ["array", "null"], "items": {"type": "string"}}
sdf-schema-1.1.json
to
Target classifier
{"type": ["string", "null"]}
sdf-schema-1.1.json
from
Expected source classifier
{"type": ["string", "null"]}
sdf-schema-1.1.json
Partition
A partition is a table column, used to describe to which partition this row belongs to
{"type": "object", "required": ["name"], "properties": {"name": {"type": "string"}, "format": {"type": ["string", "null"]}}, "additionalProperties": false}
sdf-schema-1.1.json
name
The name of the partition column
{"type": "string"}
sdf-schema-1.1.json
description
A description of the partition column
{"type": ["string", "null"]}
sdf-schema-1.1.json
format
The format of the partition column [use strftime format for date/time] See (guide)[https://docs.sdf.com/guide/schedules]
{"type": ["string", "null"]}
sdf-schema-1.1.json
Materialization
All derived tables are cached by default
{"type": "string", "enum": ["cached"]}
sdf-schema-1.1.json
Materialization
External tables must be explicitly marked When using 'Create external table` SQL syntax
{"type": "string", "enum": ["external"]}
sdf-schema-1.1.json
Materialization
View
{"type": "string", "enum": ["view"]}
sdf-schema-1.1.json
Materialization
Ephemeral
{"type": "string", "enum": ["ephemeral"]}
sdf-schema-1.1.json
Materialization
Recursive warehouse tables must be explicitly marked
{"type": "string", "enum": ["recursive"]}
sdf-schema-1.1.json
FileFormat
Store table data in these formats
{"type": "string", "enum": ["parquet", "csv", "json"]}