Docs
Server
Where the data physically lives, including the connection target and the per-technology settings for each supported server type.
Server
type: Server
Data source details of where data is physically stored.
| Property | Type | Required | Description |
|---|---|---|---|
customProperties | Array | No | |
description | string | No | Description of the server. |
Description of the server. | |||
environment | string | No | Environment of the server. Examples: prod, preprod, dev, uat. |
Environment of the server. Examples: prod, preprod, dev, uat. | |||
roles | Role [] | No | List of roles that have access to the server. |
List of roles that have access to the server. | |||
server | string | Yes | Identifier of the server. |
Identifier of the server. | |||
type | string | Yes | Type of the server. Valid values are: api, athena, azure, bigquery, clickhouse, databricks, denodo, dremio, duckdb, glue, cloudsql, db2, informix, kafka, kinesis, local, mysql, oracle, postgresql, postgres, presto, pubsub, redshift, s3, sftp, snowflake, sqlserver, synapse, trino, vertica, custom. |
Type of the server. Valid values are: api, athena, azure, bigquery, clickhouse, databricks, denodo, dremio, duckdb, glue, cloudsql, db2, informix, kafka, kinesis, local, mysql, oracle, postgresql, postgres, presto, pubsub, redshift, s3, sftp, snowflake, sqlserver, synapse, trino, vertica, custom. | |||
Specific Type Properties & Types
api( See ApiServer )athena( See AthenaServer )azure( See AzureServer )bigquery( See BigQueryServer )clickhouse( See ClickHouseServer )databricks( See DatabricksServer )denodo( See DenodoServer )dremio( See DremioServer )duckdb( See DuckdbServer )glue( See GlueServer )cloudsql( See GoogleCloudSqlServer )db2( See IBMDB2Server )informix( See InformixServer )custom( See CustomServer )kafka( See KafkaServer )kinesis( See KinesisServer )local( See LocalServer )mysql( See MySqlServer )oracle( See OracleServer )postgresql( See PostgresServer )postgres( See PostgresServer )presto( See PrestoServer )pubsub( See PubSubServer )redshift( See RedshiftServer )s3( See S3Server )sftp( See SftpServer )snowflake( See SnowflakeServer )sqlserver( See SqlserverServer )synapse( See SynapseServer )trino( See TrinoServer )vertica( See VerticaServer )
Server Source
type: ServerSource
Child elements:
- ApiServer
- AthenaServer
- AzureServer
- BigQueryServer
- ClickHouseServer
- CustomServer
- DatabricksServer
- DenodoServer
- DremioServer
- DuckdbServer
- GlueServer
- GoogleCloudSqlServer
- IBMDB2Server
- InformixServer
- KafkaServer
- KinesisServer
- LocalServer
- MySqlServer
- OracleServer
- PostgresServer
- PrestoServer
- PubSubServer
- RedshiftServer
- S3Server
- SftpServer
- SnowflakeServer
- SqlserverServer
- SynapseServer
- TrinoServer
- VerticaServer
REST API
type: AthenaServer
| Property | Type | Required | Description |
|---|---|---|---|
location | string | Yes | The url to the API. Examples: https://api.example.com/v1. |
The url to the API. Examples: https://api.example.com/v1. | |||
Amazon Athena
type: AthenaServer
| Property | Type | Required | Description |
|---|---|---|---|
catalog | string | No | Identify the name of the Data Source, also referred to as a Catalog. Default value is: awsdatacatalog. |
Identify the name of the Data Source, also referred to as a Catalog. Default value is: awsdatacatalog. | |||
regionName | string | No | The region your AWS account uses. Examples: eu-west-1. |
The region your AWS account uses. Examples: eu-west-1. | |||
schema | string | Yes | Identify the schema in the data source in which your tables exist. |
Identify the schema in the data source in which your tables exist. | |||
stagingDir | string | No | Amazon Athena automatically stores query results and metadata information for each query that runs in a query result location that you can specify in Amazon S3. Examples: s3://my_storage_account_name/my_container/path. |
Amazon Athena automatically stores query results and metadata information for each query that runs in a query result location that you can specify in Amazon S3. Examples: s3://my_storage_account_name/my_container/path. | |||
Azure Blob / ADLS
type: AzureServer
| Property | Type | Required | Description |
|---|---|---|---|
delimiter | string | No | Only for format = json. How multiple json documents are delimited within one file Valid values are: new_line, array. |
Only for format = json. How multiple json documents are delimited within one file Valid values are: new_line, array. | |||
format | string | Yes | File format. Valid values are: parquet, delta, json, csv. |
File format. Valid values are: parquet, delta, json, csv. | |||
location | string | Yes | Fully qualified path to Azure Blob Storage or Azure Data Lake Storage (ADLS), supports globs. Examples: az://my_storage_account_name.blob.core.windows.net/my_container/path/*.parquet, abfss://my_storage_account_name.dfs.core.windows.net/my_container_name/path/*.parquet. |
Fully qualified path to Azure Blob Storage or Azure Data Lake Storage (ADLS), supports globs. Examples: az://my_storage_account_name.blob.core.windows.net/my_container/path/*.parquet, abfss://my_storage_account_name.dfs.core.windows.net/my_container_name/path/*.parquet. | |||
Google BigQuery
type: BigQueryServer
| Property | Type | Required | Description |
|---|---|---|---|
dataset | string | Yes | The GCP dataset name. |
The GCP dataset name. | |||
project | string | Yes | The GCP project name. |
The GCP project name. | |||
ClickHouse
type: ClickHouseServer
| Property | Type | Required | Description |
|---|---|---|---|
database | string | Yes | The name of the database. |
The name of the database. | |||
host | string | Yes | The host of the ClickHouse server. |
The host of the ClickHouse server. | |||
port | integer | Yes | The port to the ClickHouse server. |
The port to the ClickHouse server. | |||
Custom
type: CustomServer
| Property | Type | Required | Description |
|---|---|---|---|
account | string | No | Account used by the server. |
Account used by the server. | |||
catalog | string | No | Name of the catalog. |
Name of the catalog. | |||
database | string | No | Name of the database. |
Name of the database. | |||
dataset | string | No | Name of the dataset. |
Name of the dataset. | |||
delimiter | string | No | Delimiter. |
Delimiter. | |||
endpointUrl | string | No | Server endpoint. |
Server endpoint. | |||
format | string | No | File format. |
File format. | |||
host | string | No | Host name or IP address. |
Host name or IP address. | |||
location | string | No | A URL to a location. |
A URL to a location. | |||
path | string | No | Relative or absolute path to the data file(s). |
Relative or absolute path to the data file(s). | |||
port | integer | No | Port to the server. No default value is assumed for custom servers. |
Port to the server. No default value is assumed for custom servers. | |||
project | string | No | Project name. |
Project name. | |||
region | string | No | Cloud region. |
Cloud region. | |||
regionName | string | No | Region name. |
Region name. | |||
schema | string | No | Name of the schema. |
Name of the schema. | |||
serviceName | string | No | Name of the service. |
Name of the service. | |||
stagingDir | string | No | Staging directory. |
Staging directory. | |||
warehouse | string | No | Name of the cluster or warehouse. |
Name of the cluster or warehouse. | |||
Databricks
type: DatabricksServer
| Property | Type | Required | Description |
|---|---|---|---|
catalog | string | Yes | The name of the Hive or Unity catalog |
The name of the Hive or Unity catalog | |||
host | string | No | The Databricks host Examples: dbc-abcdefgh-1234.cloud.databricks.com. |
The Databricks host Examples: dbc-abcdefgh-1234.cloud.databricks.com. | |||
schema | string | Yes | The schema name in the catalog |
The schema name in the catalog | |||
Denodo
type: DenodoServer
| Property | Type | Required | Description |
|---|---|---|---|
database | string | No | The name of the database. |
The name of the database. | |||
host | string | Yes | The host of the Denodo server. |
The host of the Denodo server. | |||
port | integer | Yes | The port of the Denodo server. |
The port of the Denodo server. | |||
Dremio
type: DremioServer
| Property | Type | Required | Description |
|---|---|---|---|
host | string | Yes | The host of the Dremio server. |
The host of the Dremio server. | |||
port | integer | Yes | The port of the Dremio server. |
The port of the Dremio server. | |||
schema | string | No | The name of the schema. |
The name of the schema. | |||
DuckDB
type: DuckdbServer
| Property | Type | Required | Description |
|---|---|---|---|
database | string | Yes | Path to duckdb database file. |
Path to duckdb database file. | |||
schema | integer | No | The name of the schema. |
The name of the schema. | |||
AWS Glue
type: GlueServer
| Property | Type | Required | Description |
|---|---|---|---|
account | string | Yes | The AWS Glue account Examples: 1234-5678-9012. |
The AWS Glue account Examples: 1234-5678-9012. | |||
database | string | Yes | The AWS Glue database name Examples: my_database. |
The AWS Glue database name Examples: my_database. | |||
format | string | No | The format of the files Examples: parquet, csv, json, delta. |
The format of the files Examples: parquet, csv, json, delta. | |||
location | string | No | The AWS S3 path. Must be in the form of a URL. Examples: s3://datacontract-example-orders-latest/data/{model}. |
The AWS S3 path. Must be in the form of a URL. Examples: s3://datacontract-example-orders-latest/data/{model}. | |||
Google Cloud SQL
type: GoogleCloudSqlServer
| Property | Type | Required | Description |
|---|---|---|---|
database | string | Yes | The name of the database. |
The name of the database. | |||
host | string | Yes | The host of the Google Cloud Sql server. |
The host of the Google Cloud Sql server. | |||
port | integer | Yes | The port of the Google Cloud Sql server. |
The port of the Google Cloud Sql server. | |||
schema | string | Yes | The name of the schema. |
The name of the schema. | |||
IBM Db2
type: IBMDB2Server
| Property | Type | Required | Description |
|---|---|---|---|
database | string | Yes | The name of the database. |
The name of the database. | |||
host | string | Yes | The host of the IBM DB2 server. |
The host of the IBM DB2 server. | |||
port | integer | Yes | The port of the IBM DB2 server. |
The port of the IBM DB2 server. | |||
schema | string | No | The name of the schema. |
The name of the schema. | |||
IBM Informix
type: InformixServer
| Property | Type | Required | Description |
|---|---|---|---|
database | string | Yes | The name of the database. |
The name of the database. | |||
host | string | Yes | The host to the Informix server. |
The host to the Informix server. | |||
port | integer | No | The port to the Informix server. Defaults to 9088. |
The port to the Informix server. Defaults to 9088. | |||
Apache Kafka
type: KafkaServer
Kafka Server
| Property | Type | Required | Description |
|---|---|---|---|
format | string | No | The format of the messages. Default value is: json. Examples: json, avro, protobuf, xml. |
The format of the messages. Default value is: json. Examples: json, avro, protobuf, xml. | |||
host | string | Yes | The bootstrap server of the kafka cluster. |
The bootstrap server of the kafka cluster. | |||
Amazon Kinesis
type: KinesisDataStreamsServer
Kinesis Data Streams Server
| Property | Type | Required | Description |
|---|---|---|---|
format | string | No | The format of the record Examples: json, avro, protobuf. |
The format of the record Examples: json, avro, protobuf. | |||
region | string | No | AWS region. Examples: eu-west-1. |
AWS region. Examples: eu-west-1. | |||
Local
type: LocalServer
| Property | Type | Required | Description |
|---|---|---|---|
format | string | Yes | The format of the file(s) Examples: json, parquet, delta, csv. |
The format of the file(s) Examples: json, parquet, delta, csv. | |||
path | string | Yes | The relative or absolute path to the data file(s). Examples: ./folder/data.parquet, ./folder/*.parquet. |
The relative or absolute path to the data file(s). Examples: ./folder/data.parquet, ./folder/*.parquet. | |||
MySQL
type: MySqlServer
| Property | Type | Required | Description |
|---|---|---|---|
database | string | Yes | The name of the database. |
The name of the database. | |||
host | string | Yes | The host of the MySql server. |
The host of the MySql server. | |||
port | integer | Yes | The port of the MySql server. |
The port of the MySql server. | |||
Oracle
type: OracleServer
| Property | Type | Required | Description |
|---|---|---|---|
host | string | Yes | The host to the oracle server Examples: localhost. |
The host to the oracle server Examples: localhost. | |||
port | integer | Yes | The port to the oracle server. Examples: 1523. |
The port to the oracle server. Examples: 1523. | |||
serviceName | string | Yes | The name of the service. Examples: service. |
The name of the service. Examples: service. | |||
PostgreSQL
type: PostgresServer
| Property | Type | Required | Description |
|---|---|---|---|
database | string | Yes | The name of the database. |
The name of the database. | |||
host | string | Yes | The host to the Postgres server |
The host to the Postgres server | |||
port | integer | Yes | The port to the Postgres server. |
The port to the Postgres server. | |||
schema | string | Yes | The name of the schema in the database. |
The name of the schema in the database. | |||
Presto
type: PrestoServer
| Property | Type | Required | Description |
|---|---|---|---|
catalog | string | No | The name of the catalog. Examples: postgres. |
The name of the catalog. Examples: postgres. | |||
host | string | Yes | The host to the Presto server Examples: localhost:8080. |
The host to the Presto server Examples: localhost:8080. | |||
schema | string | No | The name of the schema. Examples: public. |
The name of the schema. Examples: public. | |||
Google Pub/Sub
type: PubSubServer
| Property | Type | Required | Description |
|---|---|---|---|
project | string | Yes | The GCP project name. |
The GCP project name. | |||
Amazon Redshift
type: RedshiftServer
| Property | Type | Required | Description |
|---|---|---|---|
account | string | No | The account used by the server. |
The account used by the server. | |||
database | string | Yes | The name of the database. |
The name of the database. | |||
host | string | No | An optional string describing the server. |
An optional string describing the server. | |||
region | string | No | AWS region of Redshift server. Examples: us-east-1. |
AWS region of Redshift server. Examples: us-east-1. | |||
schema | string | Yes | The name of the schema. |
The name of the schema. | |||
Amazon S3
type: S3Server
| Property | Type | Required | Description |
|---|---|---|---|
delimiter | string | No | Only for format = json. How multiple json documents are delimited within one file Valid values are: new_line, array. |
Only for format = json. How multiple json documents are delimited within one file Valid values are: new_line, array. | |||
endpointUrl | string | No | The server endpoint for S3-compatible servers. Examples: https://minio.example.com. |
The server endpoint for S3-compatible servers. Examples: https://minio.example.com. | |||
format | string | No | File format. Valid values are: parquet, delta, json, csv. |
File format. Valid values are: parquet, delta, json, csv. | |||
location | string | Yes | S3 URL, starting with s3:// Examples: s3://datacontract-example-orders-latest/data/{model}/*.json. |
S3 URL, starting with s3:// Examples: s3://datacontract-example-orders-latest/data/{model}/*.json. | |||
SFTP
type: SftpServer
| Property | Type | Required | Description |
|---|---|---|---|
delimiter | string | No | Only for format = json. How multiple json documents are delimited within one file Valid values are: new_line, array. |
Only for format = json. How multiple json documents are delimited within one file Valid values are: new_line, array. | |||
format | string | No | File format. Valid values are: parquet, delta, json, csv. |
File format. Valid values are: parquet, delta, json, csv. | |||
location | string | Yes | SFTP URL, starting with sftp:// Examples: sftp://123.123.12.123/{model}/*.json. |
SFTP URL, starting with sftp:// Examples: sftp://123.123.12.123/{model}/*.json. | |||
Snowflake
type: SnowflakeServer
| Property | Type | Required | Description |
|---|---|---|---|
account | string | Yes | The Snowflake account used by the server. |
The Snowflake account used by the server. | |||
database | string | Yes | The name of the database. |
The name of the database. | |||
host | string | No | The host to the Snowflake server |
The host to the Snowflake server | |||
port | integer | No | The port to the Snowflake server. |
The port to the Snowflake server. | |||
schema | string | Yes | The name of the schema. |
The name of the schema. | |||
warehouse | string | No | The name of the cluster of resources that is a Snowflake virtual warehouse. |
The name of the cluster of resources that is a Snowflake virtual warehouse. | |||
Microsoft SQL Server
type: SqlserverServer
| Property | Type | Required | Description |
|---|---|---|---|
database | string | Yes | The name of the database. Examples: database. |
The name of the database. Examples: database. | |||
host | string | Yes | The host to the database server Examples: localhost. |
The host to the database server Examples: localhost. | |||
port | integer | No | The port to the database server. Default value is: 1433. Examples: 1433. |
The port to the database server. Default value is: 1433. Examples: 1433. | |||
schema | string | Yes | The name of the schema in the database. Examples: dbo. |
The name of the schema in the database. Examples: dbo. | |||
Azure Synapse
type: SynapseServer
| Property | Type | Required | Description |
|---|---|---|---|
database | string | Yes | The name of the database. |
The name of the database. | |||
host | string | Yes | The host of the Synapse server. |
The host of the Synapse server. | |||
port | integer | Yes | The port of the Synapse server. |
The port of the Synapse server. | |||
Trino
type: TrinoServer
| Property | Type | Required | Description |
|---|---|---|---|
catalog | string | Yes | The name of the catalog. Examples: hive. |
The name of the catalog. Examples: hive. | |||
host | string | Yes | The Trino host URL. Examples: localhost. |
The Trino host URL. Examples: localhost. | |||
port | integer | Yes | The Trino port. |
The Trino port. | |||
schema | string | Yes | The name of the schema in the database. Examples: my_schema. |
The name of the schema in the database. Examples: my_schema. | |||
Vertica
type: VerticaServer
| Property | Type | Required | Description |
|---|---|---|---|
database | string | Yes | The name of the database. |
The name of the database. | |||
host | string | Yes | The host of the Vertica server. |
The host of the Vertica server. | |||
port | integer | Yes | The port of the Vertica server. |
The port of the Vertica server. | |||
schema | string | Yes | The name of the schema. |
The name of the schema. | |||
Last updated on November 1, 2026