The servers element describes where the data protected by this data contract is physically located. That metadata helps to know where the data is so that a data consumer can discover the data and a platform engineer can automate access.
An entry in servers describes a single dataset on a specific environment and a specific technology. The servers element can contain multiple servers, each with its own configuration.
The typical ways of using the top level servers element are as follows:
- Single Server: The data contract protects a specific dataset at a specific location. Example: a CSV file on an SFTP server.
- Multiple Environments: The data contract makes sure that the data is protected in all environments. Example: a data product with data in a dev(elopment), UAT, and prod(uction) environment on Databricks.
Back to TOC
Each server in the schema has the following structure:
servers:
- id: my_awesome_server
server: my-server-name
type: <server-type>
description: <server-description>
environment: <server-environment>
<server-type-specific-fields> # according to the server type, see below
roles:
- <role-details>
customProperties:
- <custom-properties>
| Key | Type | UX label | Required | Description |
|---|
| server | string | Server | Yes | Identifier of the server. |
| id | string | ID | No | A unique identifier used to reduce the risk of collisions, such as a UUID. |
| type | string | Type | Yes | Type of the server. Can be one of: api, athena, azure, bigquery, clickhouse, cloudsql, custom, databricks, db2, denodo, dremio, duckdb, glue, hive, impala, informix, kafka, kinesis, local, mysql, oracle, postgres, postgresql, presto, pubsub, redshift, s3, sftp, snowflake, sqlserver, synapse, trino, vertica, zen. |
| description | string | Description | No | Description of the server. |
| environment | string | Environment | No | Environment of the server. Examples includes: prod, preprod, dev, uat. |
| roles | array | Roles | No | List of roles that have access to the server. Check roles section for more details. |
| customProperties | array | Custom Properties | No | Custom properties that are not part of the standard. |
Each server type can be customized with different properties such as host, port, database, and schema, depending on the server technology in use. Refer to the specific documentation for each server type for additional configurations.
If your server is not in the list, please use custom and suggest it as an improvement. Possible values for type are:
| Key | Type | UX Label | Required | Description |
|---|
| location | string | Location | Yes | URL to the API |
Amazon Athena is an interactive query service that makes it easy to analyze data directly in Amazon Simple Storage Service (Amazon S3) using standard SQL. With a few actions in the AWS Management Console, you can point Athena at your data stored in Amazon S3 and begin using standard SQL to run ad-hoc queries and get results in seconds.
| Key | Type | UX Label | Required | Description |
|---|
| schema | string | Schema | Yes | Identify the schema in the data source in which your tables exist. |
| stagingDir | string | Staging Directory | 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. |
| catalog | string | Catalog | No | Identify the name of the Data Source, also referred to as a Catalog. |
| regionName | string | Region Name | No | The region your AWS account uses. |
| Key | Type | UX Label | Required | Description |
|---|
| location | string | Location | Yes | Fully qualified path to Azure Blob Storage or Azure Data Lake Storage (ADLS), supports globs. |
| format | string | Format | Yes | File format. |
| delimiter | string | Delimiter | No | Only for format = json. How multiple json documents are delimited within one file |
BigQuery is a fully managed, AI-ready data analytics platform that helps you maximize value from your data and is designed to be multi-engine, multi-format, and multi-cloud.
| Key | Type | UX Label | Required | Description |
|---|
| project | string | Project | Yes | The Google Cloud Platform (GCP) project name. |
| dataset | string | Dataset | Yes | The GCP dataset name. |
ClickHouse is an open-source column-oriented database management system that allows generating analytical data reports in real-time.
| Key | Type | UX Label | Required | Description |
|---|
| host | string | Host | Yes | The host of the ClickHouse server. |
| port | integer | Port | Yes | The port to the ClickHouse server. |
| database | string | Database | Yes | The name of the database. |
Google Cloud SQL is a fully managed, cost-effective relational database service for PostgreSQL, MySQL, and SQL Server.
| Key | Type | UX Label | Required | Description |
|---|
| host | string | Host | Yes | The host of the Google Cloud SQL server. |
| port | integer | Port | Yes | The port of the Google Cloud SQL server. |
| database | string | Database | Yes | The name of the database. |
| schema | string | Schema | Yes | The name of the schema. |
| Key | Type | UX Label | Required | Description |
|---|
| catalog | string | Catalog | Yes | The name of the Hive or Unity catalog |
| schema | string | Schema | Yes | The schema name in the catalog |
| host | string | Host | No | The Databricks host |
| Key | Type | UX Label | Required | Description |
|---|
| host | string | Host | Yes | The host of the IBM DB2 server. |
| port | integer | Port | Yes | The port of the IBM DB2 server. |
| database | string | Database | Yes | The name of the database. |
| schema | string | Schema | No | The name of the schema. |
| Key | Type | UX Label | Required | Description |
|---|
| host | string | Host | Yes | The host of the Denodo server. |
| port | integer | Port | Yes | The port of the Denodo server. |
| database | string | Database | No | The name of the database. |
| Key | Type | UX Label | Required | Description |
|---|
| host | string | Host | Yes | The host of the Dremio server. |
| port | integer | Port | Yes | The port of the Dremio server. |
| schema | string | Schema | No | The name of the schema. |
DuckDB supports a feature-rich SQL dialect complemented with deep integrations into client APIs.
| Key | Type | UX Label | Required | Description |
|---|
| database | string | Database | Yes | Path to duckdb database file. |
| schema | string | Schema | No | The name of the schema. |
| Key | Type | UX Label | Required | Description |
|---|
| account | string | Account | Yes | The AWS Glue account |
| database | string | Database | Yes | The AWS Glue database name |
| location | string | Location | No | The AWS S3 path. Must be in the form of a URL. |
| format | string | Format | No | The format of the files |
Apache Hive is a distributed, fault-tolerant data warehouse system that enables analytics at massive scale. Built on top of Apache Hadoop, Hive allows users to read, write, and manage petabytes of data using SQL-like queries through HiveQL, with native support for cloud storage systems and enterprise-grade security features.
| Key | Type | UX Label | Required | Description |
|---|
| host | string | Host | Yes | The host to the Hive server. |
| port | integer | Port | No | The port to the Hive server. Defaults to 10000. |
| database | string | Database | Yes | The name of the Hive database. |
Apache Impala is a massively parallel processing (MPP) SQL query engine for data stored in Apache Hadoop clusters. Impala provides high-performance, low-latency SQL queries on data stored in HDFS and Apache HBase, enabling interactive exploration and analytics without data movement or transformation.
| Key | Type | UX Label | Required | Description |
|---|
| host | string | Host | Yes | The host to the Impala server. |
| port | integer | Port | No | The port to the Impala server. Defaults to 21050. |
| database | string | Database | Yes | The name of the Impala database. |
IBM Informix is a high performance, always-on, highly scalable and easily embeddable enterprise-class database optimized for the most demanding transactional and analytics workloads. As an object-relational engine, IBM Informix seamlessly integrates the best of relational and object-oriented capabilities enabling the flexible modeling of complex data structures and relationships.
| Key | Type | UX Label | Required | Description |
|---|
| host | string | Host | Yes | The host to the Informix server. |
| port | integer | Port | No | The port to the Informix server. Defaults to 9088. |
| database | string | Database | Yes | The name of the database. |
| Key | Type | UX Label | Required | Description |
|---|
| host | string | Host | Yes | The bootstrap server of the kafka cluster. |
| format | string | Format | No | The format of the messages. |
| Key | Type | UX Label | Required | Description |
|---|
| stream | string | Stream | Yes | The name of the Kinesis data stream. |
| region | string | Region | No | AWS region. |
| format | string | Format | No | The format of the record |
| Key | Type | UX Label | Required | Description |
|---|
| path | string | Path | Yes | The relative or absolute path to the data file(s). |
| format | string | Format | Yes | The format of the file(s) |
| Key | Type | UX Label | Required | Description |
|---|
| host | string | Host | Yes | The host of the MySql server. |
| port | integer | Port | No | The port of the MySql server. Defaults to 3306. |
| database | string | Database | Yes | The name of the database. |
| Key | Type | UX Label | Required | Description |
|---|
| host | string | Host | Yes | The host to the Oracle server |
| port | integer | Port | Yes | The port to the Oracle server. |
| serviceName | string | Service Name | Yes | The name of the service. |
PostgreSQL is a powerful, open source object-relational database system with over 35 years of active development that has earned it a strong reputation for reliability, feature robustness, and performance.
| Key | Type | UX Label | Required | Description |
|---|
| host | string | Host | Yes | The host to the PostgreSQL server |
| port | integer | Port | No | The port to the PostgreSQL server. Defaults to 5432. |
| database | string | Database | Yes | The name of the database. |
| schema | string | Schema | No | The name of the schema in the database. |
| Key | Type | UX Label | Required | Description |
|---|
| host | string | Host | Yes | The host to the Presto server |
| catalog | string | Catalog | No | The name of the catalog. |
| schema | string | Schema | No | The name of the schema. |
Google Cloud service to Ingest events for streaming into BigQuery, data lakes or operational databases.
| Key | Type | UX Label | Required | Description |
|---|
| project | string | Project | Yes | The GCP project name. |
Amazon Redshift is a power data driven decisions with the best price-performance cloud data warehouse.
| Key | Type | UX Label | Required | Description |
|---|
| database | string | Database | Yes | The name of the database. |
| schema | string | Schema | Yes | The name of the schema. |
| host | string | Host | No | An optional string describing the server. |
| region | string | Region | No | AWS region of Redshift server. |
| account | string | Account | No | The account used by the server. |
Amazon Simple Storage Service (Amazon S3) is an object storage service offering industry-leading scalability, data availability, security, and performance. Millions of customers of all sizes and industries store, manage, analyze, and protect any amount of data for virtually any use case, such as data lakes, cloud-native applications, and mobile apps. Other vendors have implemented a compatible implementation of S3.
| Key | Type | UX Label | Required | Description |
|---|
| location | string | Location | Yes | S3 URL, starting with s3:// |
| endpointUrl | string | Endpoint URL | No | The server endpoint for S3-compatible servers. |
| format | string | Format | No | File format. |
| delimiter | string | Delimiter | No | Only for format = json. How multiple json documents are delimited within one file |
Secure File Transfer Protocol (SFTP) is a network protocol that enables secure and encrypted file transfers between a client and a server.
| Key | Type | UX Label | Required | Description |
|---|
| location | string | Location | Yes | SFTP URL, starting with sftp://. The URL should include the port number. |
| format | string | Format | No | File format. |
| delimiter | string | Delimiter | No | Only for format = json. How multiple json documents are delimited within one file |
| Key | Type | UX Label | Required | Description |
|---|
| host | string | Host | Yes | The host to the Snowflake server |
| port | integer | Port | Yes | The port to the Snowflake server. |
| account | string | Account | Yes | The Snowflake account used by the server. |
| database | string | Database | Yes | The name of the database. |
| warehouse | string | Warehouse | Yes | The name of the cluster of resources that is a Snowflake virtual warehouse. |
| schema | string | Schema | Yes | The name of the schema. |
Microsoft SQL Server is a proprietary relational database management system developed by Microsoft.
| Key | Type | UX Label | Required | Description |
|---|
| host | string | Host | Yes | The host to the database server |
| port | integer | Port | No | The port to the database server. Defaults to 1433. |
| database | string | Database | Yes | The name of the database. |
| schema | string | Schema | Yes | The name of the schema in the database. |
| Key | Type | UX Label | Required | Description |
|---|
| host | string | Host | Yes | The host of the Synapse server. |
| port | integer | Port | Yes | The port of the Synapse server. |
| database | string | Database | Yes | The name of the database. |
| Key | Type | UX Label | Required | Description |
|---|
| host | string | Host | Yes | The Trino host URL. |
| port | integer | Port | Yes | The Trino port. |
| catalog | string | Catalog | Yes | The name of the catalog. |
| schema | string | Schema | Yes | The name of the schema in the database. |
| Key | Type | UX Label | Required | Description |
|---|
| host | string | Host | Yes | The host of the Vertica server. |
| port | integer | Port | Yes | The port of the Vertica server. |
| database | string | Database | Yes | The name of the database. |
| schema | string | Schema | Yes | The name of the schema. |
Actian Zen (formerly Btrieve, later named Pervasive PSQL until version 13) is an ACID-compliant, zero-DBA, embedded, nano-footprint, multi-model, Multi-Platform database management system (DBMS).
| Key | Type | UX Label | Required | Description |
|---|
| host | string | Host | Yes | Hostname or IP address of the Zen server. |
| port | integer | Port | No | Zen server SQL connections port. Defaults to 1583. |
| database | string | Database | Yes | Database name to connect to on the Zen server. |
| Key | Type | UX Label | Required | Description |
|---|
| account | string | Account | No | Account used by the server. |
| catalog | string | Catalog | No | Name of the catalog. |
| database | string | Database | No | Name of the database. |
| dataset | string | Dataset | No | Name of the dataset. |
| delimiter | string | Delimiter | No | Delimiter. |
| endpointUrl | string | Endpoint URL | No | Server endpoint. |
| format | string | Format | No | File format. |
| host | string | Host | No | Host name or IP address. |
| location | string | Location | No | A URL to a location. |
| path | string | Path | No | Relative or absolute path to the data file(s). |
| port | integer | Port | No | Port to the server. No default value is assumed for custom servers. |
| project | string | Project | No | Project name. |
| region | string | Region | No | Cloud region. |
| regionName | string | Region Name | No | Region name. |
| schema | string | Schema | No | Name of the schema. |
| serviceName | string | Service Name | No | Name of the service. |
| stagingDir | string | Staging Directory | No | Staging directory. |
| stream | string | Stream | No | Name of the data stream. |
| warehouse | string | Warehouse | No | Name of the cluster or warehouse. |
If you need another property, use custom properties.
Back to TOC