> ## Documentation Index > Fetch the complete documentation index at: https://docs.datafold.com/llms.txt > Use this file to discover all available pages before exploring further. > Retrieve details of a specific data source by ID via the Datafold API. # Get a data source ## OpenAPI ````yaml get /api/v1/data_sources/{data_source_id} openapi: 3.1.0 info: contact: email: support@datafold.com name: API Support description: >- The Datafold API reference is a guide to our available endpoints and authentication methods. If you're just getting started with Datafold, we recommend first checking out our [documentation](https://docs.datafold.com). :::info To use the Datafold API, you should first create a Datafold API Key, which should be stored as a local environment variable named DATAFOLD_API_KEY. This can be set in your Datafold Cloud's Settings under the Account page. ::: title: Datafold API version: latest servers: - description: Default server url: https://app.datafold.com security: - ApiKeyAuth: [] paths: /api/v1/data_sources/{data_source_id}: get: tags: - Data sources summary: Get a data source operationId: get_data_source_api_v1_data_sources__data_source_id__get parameters: - in: path name: data_source_id required: true schema: title: Data source id type: integer responses: '200': content: application/json: schema: discriminator: mapping: athena: $ref: '#/components/schemas/ApiDataSourceAwsAthena' aws_s3: $ref: '#/components/schemas/ApiDataSourceS3' azure_synapse: $ref: '#/components/schemas/ApiDataSourceAzureSynapse' bigquery: $ref: '#/components/schemas/ApiDataSourceBigQuery' databricks: $ref: '#/components/schemas/ApiDataSourceDatabricks' db2: $ref: '#/components/schemas/ApiDataSourceDB2' dremio: $ref: '#/components/schemas/ApiDataSourceDremio' duckdb: $ref: '#/components/schemas/ApiDataSourceDuckDB' files_azure_datalake: $ref: '#/components/schemas/ApiDataSourceAzureDataLake' google_cloud_storage: $ref: '#/components/schemas/ApiDataSourceGCS' mariadb: $ref: '#/components/schemas/ApiDataSourceMariaDB' microsoft_fabric: $ref: '#/components/schemas/ApiDataSourceMicrosoftFabric' mongodb: $ref: '#/components/schemas/ApiDataSourceMongoDB' mssql: $ref: '#/components/schemas/ApiDataSourceMSSQL' mysql: $ref: '#/components/schemas/ApiDataSourceMySQL' netezza: $ref: '#/components/schemas/ApiDataSourceNetezza' oracle: $ref: '#/components/schemas/ApiDataSourceOracle' pg: $ref: '#/components/schemas/ApiDataSourcePostgres' postgres_aurora: $ref: '#/components/schemas/ApiDataSourcePostgresAurora' postgres_aws_rds: $ref: '#/components/schemas/ApiDataSourcePostgresRds' redshift: $ref: '#/components/schemas/ApiDataSourceRedshift' sap_hana: $ref: '#/components/schemas/ApiDataSourceSapHana' snowflake: $ref: '#/components/schemas/ApiDataSourceSnowflake' starburst: $ref: '#/components/schemas/ApiDataSourceStarburst' teradata: $ref: '#/components/schemas/ApiDataSourceTeradata' trino: $ref: '#/components/schemas/ApiDataSourceTrino' vertica: $ref: '#/components/schemas/ApiDataSourceVertica' propertyName: type oneOf: - $ref: '#/components/schemas/ApiDataSourceBigQuery' - $ref: '#/components/schemas/ApiDataSourceDatabricks' - $ref: '#/components/schemas/ApiDataSourceDuckDB' - $ref: '#/components/schemas/ApiDataSourceMongoDB' - $ref: '#/components/schemas/ApiDataSourceMySQL' - $ref: '#/components/schemas/ApiDataSourceMariaDB' - $ref: '#/components/schemas/ApiDataSourceMSSQL' - $ref: '#/components/schemas/ApiDataSourceOracle' - $ref: '#/components/schemas/ApiDataSourcePostgres' - $ref: '#/components/schemas/ApiDataSourcePostgresAurora' - $ref: '#/components/schemas/ApiDataSourcePostgresRds' - $ref: '#/components/schemas/ApiDataSourceRedshift' - $ref: '#/components/schemas/ApiDataSourceTeradata' - $ref: '#/components/schemas/ApiDataSourceSapHana' - $ref: '#/components/schemas/ApiDataSourceDB2' - $ref: '#/components/schemas/ApiDataSourceAwsAthena' - $ref: '#/components/schemas/ApiDataSourceSnowflake' - $ref: '#/components/schemas/ApiDataSourceDremio' - $ref: '#/components/schemas/ApiDataSourceStarburst' - $ref: '#/components/schemas/ApiDataSourceNetezza' - $ref: '#/components/schemas/ApiDataSourceAzureDataLake' - $ref: '#/components/schemas/ApiDataSourceGCS' - $ref: '#/components/schemas/ApiDataSourceS3' - $ref: '#/components/schemas/ApiDataSourceAzureSynapse' - $ref: '#/components/schemas/ApiDataSourceMicrosoftFabric' - $ref: '#/components/schemas/ApiDataSourceVertica' - $ref: '#/components/schemas/ApiDataSourceTrino' title: >- Response Get Data Source Api V1 Data Sources Data Source Id Get description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error components: schemas: ApiDataSourceAwsAthena: properties: accessible: default: true title: Accessible type: boolean catalog_exclude_list: anyOf: - type: string - type: 'null' title: Catalog Exclude List catalog_include_list: anyOf: - type: string - type: 'null' title: Catalog Include List created_from: anyOf: - type: string - type: 'null' title: Created From data_retention_days: anyOf: - type: integer - type: 'null' title: Data Retention Days disable_profiling: anyOf: - type: boolean - type: 'null' default: false title: Disable Profiling disable_schema_indexing: anyOf: - type: boolean - type: 'null' default: false title: Disable Schema Indexing float_tolerance: anyOf: - type: number - type: 'null' default: 0 title: Float Tolerance group_ids: anyOf: - items: type: integer type: array - type: 'null' title: Group Ids groups: anyOf: - additionalProperties: type: boolean type: object - type: 'null' title: Groups hidden: anyOf: - type: boolean - type: 'null' default: false title: Hidden id: anyOf: - type: integer - type: 'null' title: Id is_paused: anyOf: - type: boolean - type: 'null' default: false title: Is Paused last_test: anyOf: - $ref: '#/components/schemas/ApiDataSourceTestStatus' - type: 'null' lineage_schedule: anyOf: - type: string - type: 'null' title: Lineage Schedule max_allowed_connections: anyOf: - type: integer - type: 'null' title: Max Allowed Connections name: title: Name type: string oauth_dwh_active: anyOf: - type: boolean - type: 'null' title: Oauth Dwh Active options: anyOf: - $ref: '#/components/schemas/AwsAthenaConfig' - type: 'null' profile_exclude_list: anyOf: - type: string - type: 'null' title: Profile Exclude List profile_include_list: anyOf: - type: string - type: 'null' title: Profile Include List profile_schedule: anyOf: - type: string - type: 'null' title: Profile Schedule queue_name: anyOf: - type: string - type: 'null' title: Queue Name scheduled_queue_name: anyOf: - type: string - type: 'null' title: Scheduled Queue Name schema_indexing_schedule: anyOf: - type: string - type: 'null' title: Schema Indexing Schedule schema_max_age_s: anyOf: - type: integer - type: 'null' title: Schema Max Age S secret_id: anyOf: - type: integer - type: 'null' title: Secret Id source: anyOf: - type: string - type: 'null' title: Source temp_schema: anyOf: - type: string - type: 'null' title: Temp Schema type: const: athena title: Type type: string view_only: anyOf: - type: boolean - type: 'null' default: false title: View Only required: - name - type title: ApiDataSourceAwsAthena type: object ApiDataSourceS3: properties: accessible: default: true title: Accessible type: boolean catalog_exclude_list: anyOf: - type: string - type: 'null' title: Catalog Exclude List catalog_include_list: anyOf: - type: string - type: 'null' title: Catalog Include List created_from: anyOf: - type: string - type: 'null' title: Created From data_retention_days: anyOf: - type: integer - type: 'null' title: Data Retention Days disable_profiling: anyOf: - type: boolean - type: 'null' default: false title: Disable Profiling disable_schema_indexing: anyOf: - type: boolean - type: 'null' default: false title: Disable Schema Indexing float_tolerance: anyOf: - type: number - type: 'null' default: 0 title: Float Tolerance group_ids: anyOf: - items: type: integer type: array - type: 'null' title: Group Ids groups: anyOf: - additionalProperties: type: boolean type: object - type: 'null' title: Groups hidden: anyOf: - type: boolean - type: 'null' default: false title: Hidden id: anyOf: - type: integer - type: 'null' title: Id is_paused: anyOf: - type: boolean - type: 'null' default: false title: Is Paused last_test: anyOf: - $ref: '#/components/schemas/ApiDataSourceTestStatus' - type: 'null' lineage_schedule: anyOf: - type: string - type: 'null' title: Lineage Schedule max_allowed_connections: anyOf: - type: integer - type: 'null' title: Max Allowed Connections name: title: Name type: string oauth_dwh_active: anyOf: - type: boolean - type: 'null' title: Oauth Dwh Active options: anyOf: - $ref: '#/components/schemas/AWSS3Config' - type: 'null' profile_exclude_list: anyOf: - type: string - type: 'null' title: Profile Exclude List profile_include_list: anyOf: - type: string - type: 'null' title: Profile Include List profile_schedule: anyOf: - type: string - type: 'null' title: Profile Schedule queue_name: anyOf: - type: string - type: 'null' title: Queue Name scheduled_queue_name: anyOf: - type: string - type: 'null' title: Scheduled Queue Name schema_indexing_schedule: anyOf: - type: string - type: 'null' title: Schema Indexing Schedule schema_max_age_s: anyOf: - type: integer - type: 'null' title: Schema Max Age S secret_id: anyOf: - type: integer - type: 'null' title: Secret Id source: anyOf: - type: string - type: 'null' title: Source temp_schema: anyOf: - type: string - type: 'null' title: Temp Schema type: const: aws_s3 title: Type type: string view_only: anyOf: - type: boolean - type: 'null' default: false title: View Only required: - name - type title: ApiDataSourceS3 type: object ApiDataSourceAzureSynapse: properties: accessible: default: true title: Accessible type: boolean catalog_exclude_list: anyOf: - type: string - type: 'null' title: Catalog Exclude List catalog_include_list: anyOf: - type: string - type: 'null' title: Catalog Include List created_from: anyOf: - type: string - type: 'null' title: Created From data_retention_days: anyOf: - type: integer - type: 'null' title: Data Retention Days disable_profiling: anyOf: - type: boolean - type: 'null' default: false title: Disable Profiling disable_schema_indexing: anyOf: - type: boolean - type: 'null' default: false title: Disable Schema Indexing float_tolerance: anyOf: - type: number - type: 'null' default: 0 title: Float Tolerance group_ids: anyOf: - items: type: integer type: array - type: 'null' title: Group Ids groups: anyOf: - additionalProperties: type: boolean type: object - type: 'null' title: Groups hidden: anyOf: - type: boolean - type: 'null' default: false title: Hidden id: anyOf: - type: integer - type: 'null' title: Id is_paused: anyOf: - type: boolean - type: 'null' default: false title: Is Paused last_test: anyOf: - $ref: '#/components/schemas/ApiDataSourceTestStatus' - type: 'null' lineage_schedule: anyOf: - type: string - type: 'null' title: Lineage Schedule max_allowed_connections: anyOf: - type: integer - type: 'null' title: Max Allowed Connections name: title: Name type: string oauth_dwh_active: anyOf: - type: boolean - type: 'null' title: Oauth Dwh Active options: anyOf: - $ref: '#/components/schemas/MSSQLConfig' - type: 'null' profile_exclude_list: anyOf: - type: string - type: 'null' title: Profile Exclude List profile_include_list: anyOf: - type: string - type: 'null' title: Profile Include List profile_schedule: anyOf: - type: string - type: 'null' title: Profile Schedule queue_name: anyOf: - type: string - type: 'null' title: Queue Name scheduled_queue_name: anyOf: - type: string - type: 'null' title: Scheduled Queue Name schema_indexing_schedule: anyOf: - type: string - type: 'null' title: Schema Indexing Schedule schema_max_age_s: anyOf: - type: integer - type: 'null' title: Schema Max Age S secret_id: anyOf: - type: integer - type: 'null' title: Secret Id source: anyOf: - type: string - type: 'null' title: Source temp_schema: anyOf: - type: string - type: 'null' title: Temp Schema type: const: azure_synapse title: Type type: string view_only: anyOf: - type: boolean - type: 'null' default: false title: View Only required: - name - type title: ApiDataSourceAzureSynapse type: object ApiDataSourceBigQuery: properties: accessible: default: true title: Accessible type: boolean catalog_exclude_list: anyOf: - type: string - type: 'null' title: Catalog Exclude List catalog_include_list: anyOf: - type: string - type: 'null' title: Catalog Include List created_from: anyOf: - type: string - type: 'null' title: Created From data_retention_days: anyOf: - type: integer - type: 'null' title: Data Retention Days disable_profiling: anyOf: - type: boolean - type: 'null' default: false title: Disable Profiling disable_schema_indexing: anyOf: - type: boolean - type: 'null' default: false title: Disable Schema Indexing float_tolerance: anyOf: - type: number - type: 'null' default: 0 title: Float Tolerance group_ids: anyOf: - items: type: integer type: array - type: 'null' title: Group Ids groups: anyOf: - additionalProperties: type: boolean type: object - type: 'null' title: Groups hidden: anyOf: - type: boolean - type: 'null' default: false title: Hidden id: anyOf: - type: integer - type: 'null' title: Id is_paused: anyOf: - type: boolean - type: 'null' default: false title: Is Paused last_test: anyOf: - $ref: '#/components/schemas/ApiDataSourceTestStatus' - type: 'null' lineage_schedule: anyOf: - type: string - type: 'null' title: Lineage Schedule max_allowed_connections: anyOf: - type: integer - type: 'null' title: Max Allowed Connections name: title: Name type: string oauth_dwh_active: anyOf: - type: boolean - type: 'null' title: Oauth Dwh Active options: anyOf: - $ref: '#/components/schemas/BigQueryConfig' - type: 'null' profile_exclude_list: anyOf: - type: string - type: 'null' title: Profile Exclude List profile_include_list: anyOf: - type: string - type: 'null' title: Profile Include List profile_schedule: anyOf: - type: string - type: 'null' title: Profile Schedule queue_name: anyOf: - type: string - type: 'null' title: Queue Name scheduled_queue_name: anyOf: - type: string - type: 'null' title: Scheduled Queue Name schema_indexing_schedule: anyOf: - type: string - type: 'null' title: Schema Indexing Schedule schema_max_age_s: anyOf: - type: integer - type: 'null' title: Schema Max Age S secret_id: anyOf: - type: integer - type: 'null' title: Secret Id source: anyOf: - type: string - type: 'null' title: Source temp_schema: anyOf: - type: string - type: 'null' title: Temp Schema type: const: bigquery title: Type type: string view_only: anyOf: - type: boolean - type: 'null' default: false title: View Only required: - name - type title: ApiDataSourceBigQuery type: object ApiDataSourceDatabricks: properties: accessible: default: true title: Accessible type: boolean catalog_exclude_list: anyOf: - type: string - type: 'null' title: Catalog Exclude List catalog_include_list: anyOf: - type: string - type: 'null' title: Catalog Include List created_from: anyOf: - type: string - type: 'null' title: Created From data_retention_days: anyOf: - type: integer - type: 'null' title: Data Retention Days disable_profiling: anyOf: - type: boolean - type: 'null' default: false title: Disable Profiling disable_schema_indexing: anyOf: - type: boolean - type: 'null' default: false title: Disable Schema Indexing float_tolerance: anyOf: - type: number - type: 'null' default: 0 title: Float Tolerance group_ids: anyOf: - items: type: integer type: array - type: 'null' title: Group Ids groups: anyOf: - additionalProperties: type: boolean type: object - type: 'null' title: Groups hidden: anyOf: - type: boolean - type: 'null' default: false title: Hidden id: anyOf: - type: integer - type: 'null' title: Id is_paused: anyOf: - type: boolean - type: 'null' default: false title: Is Paused last_test: anyOf: - $ref: '#/components/schemas/ApiDataSourceTestStatus' - type: 'null' lineage_schedule: anyOf: - type: string - type: 'null' title: Lineage Schedule max_allowed_connections: anyOf: - type: integer - type: 'null' title: Max Allowed Connections name: title: Name type: string oauth_dwh_active: anyOf: - type: boolean - type: 'null' title: Oauth Dwh Active options: anyOf: - $ref: '#/components/schemas/DatabricksConfig' - type: 'null' profile_exclude_list: anyOf: - type: string - type: 'null' title: Profile Exclude List profile_include_list: anyOf: - type: string - type: 'null' title: Profile Include List profile_schedule: anyOf: - type: string - type: 'null' title: Profile Schedule queue_name: anyOf: - type: string - type: 'null' title: Queue Name scheduled_queue_name: anyOf: - type: string - type: 'null' title: Scheduled Queue Name schema_indexing_schedule: anyOf: - type: string - type: 'null' title: Schema Indexing Schedule schema_max_age_s: anyOf: - type: integer - type: 'null' title: Schema Max Age S secret_id: anyOf: - type: integer - type: 'null' title: Secret Id source: anyOf: - type: string - type: 'null' title: Source temp_schema: anyOf: - type: string - type: 'null' title: Temp Schema type: const: databricks title: Type type: string view_only: anyOf: - type: boolean - type: 'null' default: false title: View Only required: - name - type title: ApiDataSourceDatabricks type: object ApiDataSourceDB2: properties: accessible: default: true title: Accessible type: boolean catalog_exclude_list: anyOf: - type: string - type: 'null' title: Catalog Exclude List catalog_include_list: anyOf: - type: string - type: 'null' title: Catalog Include List created_from: anyOf: - type: string - type: 'null' title: Created From data_retention_days: anyOf: - type: integer - type: 'null' title: Data Retention Days disable_profiling: anyOf: - type: boolean - type: 'null' default: false title: Disable Profiling disable_schema_indexing: anyOf: - type: boolean - type: 'null' default: false title: Disable Schema Indexing float_tolerance: anyOf: - type: number - type: 'null' default: 0 title: Float Tolerance group_ids: anyOf: - items: type: integer type: array - type: 'null' title: Group Ids groups: anyOf: - additionalProperties: type: boolean type: object - type: 'null' title: Groups hidden: anyOf: - type: boolean - type: 'null' default: false title: Hidden id: anyOf: - type: integer - type: 'null' title: Id is_paused: anyOf: - type: boolean - type: 'null' default: false title: Is Paused last_test: anyOf: - $ref: '#/components/schemas/ApiDataSourceTestStatus' - type: 'null' lineage_schedule: anyOf: - type: string - type: 'null' title: Lineage Schedule max_allowed_connections: anyOf: - type: integer - type: 'null' title: Max Allowed Connections name: title: Name type: string oauth_dwh_active: anyOf: - type: boolean - type: 'null' title: Oauth Dwh Active options: anyOf: - $ref: '#/components/schemas/DB2Config' - type: 'null' profile_exclude_list: anyOf: - type: string - type: 'null' title: Profile Exclude List profile_include_list: anyOf: - type: string - type: 'null' title: Profile Include List profile_schedule: anyOf: - type: string - type: 'null' title: Profile Schedule queue_name: anyOf: - type: string - type: 'null' title: Queue Name scheduled_queue_name: anyOf: - type: string - type: 'null' title: Scheduled Queue Name schema_indexing_schedule: anyOf: - type: string - type: 'null' title: Schema Indexing Schedule schema_max_age_s: anyOf: - type: integer - type: 'null' title: Schema Max Age S secret_id: anyOf: - type: integer - type: 'null' title: Secret Id source: anyOf: - type: string - type: 'null' title: Source temp_schema: anyOf: - type: string - type: 'null' title: Temp Schema type: const: db2 title: Type type: string view_only: anyOf: - type: boolean - type: 'null' default: false title: View Only required: - name - type title: ApiDataSourceDB2 type: object ApiDataSourceDremio: properties: accessible: default: true title: Accessible type: boolean catalog_exclude_list: anyOf: - type: string - type: 'null' title: Catalog Exclude List catalog_include_list: anyOf: - type: string - type: 'null' title: Catalog Include List created_from: anyOf: - type: string - type: 'null' title: Created From data_retention_days: anyOf: - type: integer - type: 'null' title: Data Retention Days disable_profiling: anyOf: - type: boolean - type: 'null' default: false title: Disable Profiling disable_schema_indexing: anyOf: - type: boolean - type: 'null' default: false title: Disable Schema Indexing float_tolerance: anyOf: - type: number - type: 'null' default: 0 title: Float Tolerance group_ids: anyOf: - items: type: integer type: array - type: 'null' title: Group Ids groups: anyOf: - additionalProperties: type: boolean type: object - type: 'null' title: Groups hidden: anyOf: - type: boolean - type: 'null' default: false title: Hidden id: anyOf: - type: integer - type: 'null' title: Id is_paused: anyOf: - type: boolean - type: 'null' default: false title: Is Paused last_test: anyOf: - $ref: '#/components/schemas/ApiDataSourceTestStatus' - type: 'null' lineage_schedule: anyOf: - type: string - type: 'null' title: Lineage Schedule max_allowed_connections: anyOf: - type: integer - type: 'null' title: Max Allowed Connections name: title: Name type: string oauth_dwh_active: anyOf: - type: boolean - type: 'null' title: Oauth Dwh Active options: anyOf: - $ref: '#/components/schemas/DremioConfig' - type: 'null' profile_exclude_list: anyOf: - type: string - type: 'null' title: Profile Exclude List profile_include_list: anyOf: - type: string - type: 'null' title: Profile Include List profile_schedule: anyOf: - type: string - type: 'null' title: Profile Schedule queue_name: anyOf: - type: string - type: 'null' title: Queue Name scheduled_queue_name: anyOf: - type: string - type: 'null' title: Scheduled Queue Name schema_indexing_schedule: anyOf: - type: string - type: 'null' title: Schema Indexing Schedule schema_max_age_s: anyOf: - type: integer - type: 'null' title: Schema Max Age S secret_id: anyOf: - type: integer - type: 'null' title: Secret Id source: anyOf: - type: string - type: 'null' title: Source temp_schema: anyOf: - type: string - type: 'null' title: Temp Schema type: const: dremio title: Type type: string view_only: anyOf: - type: boolean - type: 'null' default: false title: View Only required: - name - type title: ApiDataSourceDremio type: object ApiDataSourceDuckDB: properties: accessible: default: true title: Accessible type: boolean catalog_exclude_list: anyOf: - type: string - type: 'null' title: Catalog Exclude List catalog_include_list: anyOf: - type: string - type: 'null' title: Catalog Include List created_from: anyOf: - type: string - type: 'null' title: Created From data_retention_days: anyOf: - type: integer - type: 'null' title: Data Retention Days disable_profiling: anyOf: - type: boolean - type: 'null' default: false title: Disable Profiling disable_schema_indexing: anyOf: - type: boolean - type: 'null' default: false title: Disable Schema Indexing float_tolerance: anyOf: - type: number - type: 'null' default: 0 title: Float Tolerance group_ids: anyOf: - items: type: integer type: array - type: 'null' title: Group Ids groups: anyOf: - additionalProperties: type: boolean type: object - type: 'null' title: Groups hidden: anyOf: - type: boolean - type: 'null' default: false title: Hidden id: anyOf: - type: integer - type: 'null' title: Id is_paused: anyOf: - type: boolean - type: 'null' default: false title: Is Paused last_test: anyOf: - $ref: '#/components/schemas/ApiDataSourceTestStatus' - type: 'null' lineage_schedule: anyOf: - type: string - type: 'null' title: Lineage Schedule max_allowed_connections: anyOf: - type: integer - type: 'null' title: Max Allowed Connections name: title: Name type: string oauth_dwh_active: anyOf: - type: boolean - type: 'null' title: Oauth Dwh Active options: anyOf: - $ref: '#/components/schemas/DuckDBConfig' - type: 'null' profile_exclude_list: anyOf: - type: string - type: 'null' title: Profile Exclude List profile_include_list: anyOf: - type: string - type: 'null' title: Profile Include List profile_schedule: anyOf: - type: string - type: 'null' title: Profile Schedule queue_name: anyOf: - type: string - type: 'null' title: Queue Name scheduled_queue_name: anyOf: - type: string - type: 'null' title: Scheduled Queue Name schema_indexing_schedule: anyOf: - type: string - type: 'null' title: Schema Indexing Schedule schema_max_age_s: anyOf: - type: integer - type: 'null' title: Schema Max Age S secret_id: anyOf: - type: integer - type: 'null' title: Secret Id source: anyOf: - type: string - type: 'null' title: Source temp_schema: anyOf: - type: string - type: 'null' title: Temp Schema type: const: duckdb title: Type type: string view_only: anyOf: - type: boolean - type: 'null' default: false title: View Only required: - name - type title: ApiDataSourceDuckDB type: object ApiDataSourceAzureDataLake: properties: accessible: default: true title: Accessible type: boolean catalog_exclude_list: anyOf: - type: string - type: 'null' title: Catalog Exclude List catalog_include_list: anyOf: - type: string - type: 'null' title: Catalog Include List created_from: anyOf: - type: string - type: 'null' title: Created From data_retention_days: anyOf: - type: integer - type: 'null' title: Data Retention Days disable_profiling: anyOf: - type: boolean - type: 'null' default: false title: Disable Profiling disable_schema_indexing: anyOf: - type: boolean - type: 'null' default: false title: Disable Schema Indexing float_tolerance: anyOf: - type: number - type: 'null' default: 0 title: Float Tolerance group_ids: anyOf: - items: type: integer type: array - type: 'null' title: Group Ids groups: anyOf: - additionalProperties: type: boolean type: object - type: 'null' title: Groups hidden: anyOf: - type: boolean - type: 'null' default: false title: Hidden id: anyOf: - type: integer - type: 'null' title: Id is_paused: anyOf: - type: boolean - type: 'null' default: false title: Is Paused last_test: anyOf: - $ref: '#/components/schemas/ApiDataSourceTestStatus' - type: 'null' lineage_schedule: anyOf: - type: string - type: 'null' title: Lineage Schedule max_allowed_connections: anyOf: - type: integer - type: 'null' title: Max Allowed Connections name: title: Name type: string oauth_dwh_active: anyOf: - type: boolean - type: 'null' title: Oauth Dwh Active options: anyOf: - $ref: '#/components/schemas/AzureDataLakeConfig' - type: 'null' profile_exclude_list: anyOf: - type: string - type: 'null' title: Profile Exclude List profile_include_list: anyOf: - type: string - type: 'null' title: Profile Include List profile_schedule: anyOf: - type: string - type: 'null' title: Profile Schedule queue_name: anyOf: - type: string - type: 'null' title: Queue Name scheduled_queue_name: anyOf: - type: string - type: 'null' title: Scheduled Queue Name schema_indexing_schedule: anyOf: - type: string - type: 'null' title: Schema Indexing Schedule schema_max_age_s: anyOf: - type: integer - type: 'null' title: Schema Max Age S secret_id: anyOf: - type: integer - type: 'null' title: Secret Id source: anyOf: - type: string - type: 'null' title: Source temp_schema: anyOf: - type: string - type: 'null' title: Temp Schema type: const: files_azure_datalake title: Type type: string view_only: anyOf: - type: boolean - type: 'null' default: false title: View Only required: - name - type title: ApiDataSourceAzureDataLake type: object ApiDataSourceGCS: properties: accessible: default: true title: Accessible type: boolean catalog_exclude_list: anyOf: - type: string - type: 'null' title: Catalog Exclude List catalog_include_list: anyOf: - type: string - type: 'null' title: Catalog Include List created_from: anyOf: - type: string - type: 'null' title: Created From data_retention_days: anyOf: - type: integer - type: 'null' title: Data Retention Days disable_profiling: anyOf: - type: boolean - type: 'null' default: false title: Disable Profiling disable_schema_indexing: anyOf: - type: boolean - type: 'null' default: false title: Disable Schema Indexing float_tolerance: anyOf: - type: number - type: 'null' default: 0 title: Float Tolerance group_ids: anyOf: - items: type: integer type: array - type: 'null' title: Group Ids groups: anyOf: - additionalProperties: type: boolean type: object - type: 'null' title: Groups hidden: anyOf: - type: boolean - type: 'null' default: false title: Hidden id: anyOf: - type: integer - type: 'null' title: Id is_paused: anyOf: - type: boolean - type: 'null' default: false title: Is Paused last_test: anyOf: - $ref: '#/components/schemas/ApiDataSourceTestStatus' - type: 'null' lineage_schedule: anyOf: - type: string - type: 'null' title: Lineage Schedule max_allowed_connections: anyOf: - type: integer - type: 'null' title: Max Allowed Connections name: title: Name type: string oauth_dwh_active: anyOf: - type: boolean - type: 'null' title: Oauth Dwh Active options: anyOf: - $ref: '#/components/schemas/GCSConfig' - type: 'null' profile_exclude_list: anyOf: - type: string - type: 'null' title: Profile Exclude List profile_include_list: anyOf: - type: string - type: 'null' title: Profile Include List profile_schedule: anyOf: - type: string - type: 'null' title: Profile Schedule queue_name: anyOf: - type: string - type: 'null' title: Queue Name scheduled_queue_name: anyOf: - type: string - type: 'null' title: Scheduled Queue Name schema_indexing_schedule: anyOf: - type: string - type: 'null' title: Schema Indexing Schedule schema_max_age_s: anyOf: - type: integer - type: 'null' title: Schema Max Age S secret_id: anyOf: - type: integer - type: 'null' title: Secret Id source: anyOf: - type: string - type: 'null' title: Source temp_schema: anyOf: - type: string - type: 'null' title: Temp Schema type: const: google_cloud_storage title: Type type: string view_only: anyOf: - type: boolean - type: 'null' default: false title: View Only required: - name - type title: ApiDataSourceGCS type: object ApiDataSourceMariaDB: properties: accessible: default: true title: Accessible type: boolean catalog_exclude_list: anyOf: - type: string - type: 'null' title: Catalog Exclude List catalog_include_list: anyOf: - type: string - type: 'null' title: Catalog Include List created_from: anyOf: - type: string - type: 'null' title: Created From data_retention_days: anyOf: - type: integer - type: 'null' title: Data Retention Days disable_profiling: anyOf: - type: boolean - type: 'null' default: false title: Disable Profiling disable_schema_indexing: anyOf: - type: boolean - type: 'null' default: false title: Disable Schema Indexing float_tolerance: anyOf: - type: number - type: 'null' default: 0 title: Float Tolerance group_ids: anyOf: - items: type: integer type: array - type: 'null' title: Group Ids groups: anyOf: - additionalProperties: type: boolean type: object - type: 'null' title: Groups hidden: anyOf: - type: boolean - type: 'null' default: false title: Hidden id: anyOf: - type: integer - type: 'null' title: Id is_paused: anyOf: - type: boolean - type: 'null' default: false title: Is Paused last_test: anyOf: - $ref: '#/components/schemas/ApiDataSourceTestStatus' - type: 'null' lineage_schedule: anyOf: - type: string - type: 'null' title: Lineage Schedule max_allowed_connections: anyOf: - type: integer - type: 'null' title: Max Allowed Connections name: title: Name type: string oauth_dwh_active: anyOf: - type: boolean - type: 'null' title: Oauth Dwh Active options: anyOf: - $ref: '#/components/schemas/MariaDBConfig' - type: 'null' profile_exclude_list: anyOf: - type: string - type: 'null' title: Profile Exclude List profile_include_list: anyOf: - type: string - type: 'null' title: Profile Include List profile_schedule: anyOf: - type: string - type: 'null' title: Profile Schedule queue_name: anyOf: - type: string - type: 'null' title: Queue Name scheduled_queue_name: anyOf: - type: string - type: 'null' title: Scheduled Queue Name schema_indexing_schedule: anyOf: - type: string - type: 'null' title: Schema Indexing Schedule schema_max_age_s: anyOf: - type: integer - type: 'null' title: Schema Max Age S secret_id: anyOf: - type: integer - type: 'null' title: Secret Id source: anyOf: - type: string - type: 'null' title: Source temp_schema: anyOf: - type: string - type: 'null' title: Temp Schema type: const: mariadb title: Type type: string view_only: anyOf: - type: boolean - type: 'null' default: false title: View Only required: - name - type title: ApiDataSourceMariaDB type: object ApiDataSourceMicrosoftFabric: properties: accessible: default: true title: Accessible type: boolean catalog_exclude_list: anyOf: - type: string - type: 'null' title: Catalog Exclude List catalog_include_list: anyOf: - type: string - type: 'null' title: Catalog Include List created_from: anyOf: - type: string - type: 'null' title: Created From data_retention_days: anyOf: - type: integer - type: 'null' title: Data Retention Days disable_profiling: anyOf: - type: boolean - type: 'null' default: false title: Disable Profiling disable_schema_indexing: anyOf: - type: boolean - type: 'null' default: false title: Disable Schema Indexing float_tolerance: anyOf: - type: number - type: 'null' default: 0 title: Float Tolerance group_ids: anyOf: - items: type: integer type: array - type: 'null' title: Group Ids groups: anyOf: - additionalProperties: type: boolean type: object - type: 'null' title: Groups hidden: anyOf: - type: boolean - type: 'null' default: false title: Hidden id: anyOf: - type: integer - type: 'null' title: Id is_paused: anyOf: - type: boolean - type: 'null' default: false title: Is Paused last_test: anyOf: - $ref: '#/components/schemas/ApiDataSourceTestStatus' - type: 'null' lineage_schedule: anyOf: - type: string - type: 'null' title: Lineage Schedule max_allowed_connections: anyOf: - type: integer - type: 'null' title: Max Allowed Connections name: title: Name type: string oauth_dwh_active: anyOf: - type: boolean - type: 'null' title: Oauth Dwh Active options: anyOf: - $ref: '#/components/schemas/MicrosoftFabricConfig' - type: 'null' profile_exclude_list: anyOf: - type: string - type: 'null' title: Profile Exclude List profile_include_list: anyOf: - type: string - type: 'null' title: Profile Include List profile_schedule: anyOf: - type: string - type: 'null' title: Profile Schedule queue_name: anyOf: - type: string - type: 'null' title: Queue Name scheduled_queue_name: anyOf: - type: string - type: 'null' title: Scheduled Queue Name schema_indexing_schedule: anyOf: - type: string - type: 'null' title: Schema Indexing Schedule schema_max_age_s: anyOf: - type: integer - type: 'null' title: Schema Max Age S secret_id: anyOf: - type: integer - type: 'null' title: Secret Id source: anyOf: - type: string - type: 'null' title: Source temp_schema: anyOf: - type: string - type: 'null' title: Temp Schema type: const: microsoft_fabric title: Type type: string view_only: anyOf: - type: boolean - type: 'null' default: false title: View Only required: - name - type title: ApiDataSourceMicrosoftFabric type: object ApiDataSourceMongoDB: properties: accessible: default: true title: Accessible type: boolean catalog_exclude_list: anyOf: - type: string - type: 'null' title: Catalog Exclude List catalog_include_list: anyOf: - type: string - type: 'null' title: Catalog Include List created_from: anyOf: - type: string - type: 'null' title: Created From data_retention_days: anyOf: - type: integer - type: 'null' title: Data Retention Days disable_profiling: anyOf: - type: boolean - type: 'null' default: false title: Disable Profiling disable_schema_indexing: anyOf: - type: boolean - type: 'null' default: false title: Disable Schema Indexing float_tolerance: anyOf: - type: number - type: 'null' default: 0 title: Float Tolerance group_ids: anyOf: - items: type: integer type: array - type: 'null' title: Group Ids groups: anyOf: - additionalProperties: type: boolean type: object - type: 'null' title: Groups hidden: anyOf: - type: boolean - type: 'null' default: false title: Hidden id: anyOf: - type: integer - type: 'null' title: Id is_paused: anyOf: - type: boolean - type: 'null' default: false title: Is Paused last_test: anyOf: - $ref: '#/components/schemas/ApiDataSourceTestStatus' - type: 'null' lineage_schedule: anyOf: - type: string - type: 'null' title: Lineage Schedule max_allowed_connections: anyOf: - type: integer - type: 'null' title: Max Allowed Connections name: title: Name type: string oauth_dwh_active: anyOf: - type: boolean - type: 'null' title: Oauth Dwh Active options: anyOf: - $ref: '#/components/schemas/MongoDBConfig' - type: 'null' profile_exclude_list: anyOf: - type: string - type: 'null' title: Profile Exclude List profile_include_list: anyOf: - type: string - type: 'null' title: Profile Include List profile_schedule: anyOf: - type: string - type: 'null' title: Profile Schedule queue_name: anyOf: - type: string - type: 'null' title: Queue Name scheduled_queue_name: anyOf: - type: string - type: 'null' title: Scheduled Queue Name schema_indexing_schedule: anyOf: - type: string - type: 'null' title: Schema Indexing Schedule schema_max_age_s: anyOf: - type: integer - type: 'null' title: Schema Max Age S secret_id: anyOf: - type: integer - type: 'null' title: Secret Id source: anyOf: - type: string - type: 'null' title: Source temp_schema: anyOf: - type: string - type: 'null' title: Temp Schema type: const: mongodb title: Type type: string view_only: anyOf: - type: boolean - type: 'null' default: false title: View Only required: - name - type title: ApiDataSourceMongoDB type: object ApiDataSourceMSSQL: properties: accessible: default: true title: Accessible type: boolean catalog_exclude_list: anyOf: - type: string - type: 'null' title: Catalog Exclude List catalog_include_list: anyOf: - type: string - type: 'null' title: Catalog Include List created_from: anyOf: - type: string - type: 'null' title: Created From data_retention_days: anyOf: - type: integer - type: 'null' title: Data Retention Days disable_profiling: anyOf: - type: boolean - type: 'null' default: false title: Disable Profiling disable_schema_indexing: anyOf: - type: boolean - type: 'null' default: false title: Disable Schema Indexing float_tolerance: anyOf: - type: number - type: 'null' default: 0 title: Float Tolerance group_ids: anyOf: - items: type: integer type: array - type: 'null' title: Group Ids groups: anyOf: - additionalProperties: type: boolean type: object - type: 'null' title: Groups hidden: anyOf: - type: boolean - type: 'null' default: false title: Hidden id: anyOf: - type: integer - type: 'null' title: Id is_paused: anyOf: - type: boolean - type: 'null' default: false title: Is Paused last_test: anyOf: - $ref: '#/components/schemas/ApiDataSourceTestStatus' - type: 'null' lineage_schedule: anyOf: - type: string - type: 'null' title: Lineage Schedule max_allowed_connections: anyOf: - type: integer - type: 'null' title: Max Allowed Connections name: title: Name type: string oauth_dwh_active: anyOf: - type: boolean - type: 'null' title: Oauth Dwh Active options: anyOf: - $ref: '#/components/schemas/MSSQLConfig' - type: 'null' profile_exclude_list: anyOf: - type: string - type: 'null' title: Profile Exclude List profile_include_list: anyOf: - type: string - type: 'null' title: Profile Include List profile_schedule: anyOf: - type: string - type: 'null' title: Profile Schedule queue_name: anyOf: - type: string - type: 'null' title: Queue Name scheduled_queue_name: anyOf: - type: string - type: 'null' title: Scheduled Queue Name schema_indexing_schedule: anyOf: - type: string - type: 'null' title: Schema Indexing Schedule schema_max_age_s: anyOf: - type: integer - type: 'null' title: Schema Max Age S secret_id: anyOf: - type: integer - type: 'null' title: Secret Id source: anyOf: - type: string - type: 'null' title: Source temp_schema: anyOf: - type: string - type: 'null' title: Temp Schema type: const: mssql title: Type type: string view_only: anyOf: - type: boolean - type: 'null' default: false title: View Only required: - name - type title: ApiDataSourceMSSQL type: object ApiDataSourceMySQL: properties: accessible: default: true title: Accessible type: boolean catalog_exclude_list: anyOf: - type: string - type: 'null' title: Catalog Exclude List catalog_include_list: anyOf: - type: string - type: 'null' title: Catalog Include List created_from: anyOf: - type: string - type: 'null' title: Created From data_retention_days: anyOf: - type: integer - type: 'null' title: Data Retention Days disable_profiling: anyOf: - type: boolean - type: 'null' default: false title: Disable Profiling disable_schema_indexing: anyOf: - type: boolean - type: 'null' default: false title: Disable Schema Indexing float_tolerance: anyOf: - type: number - type: 'null' default: 0 title: Float Tolerance group_ids: anyOf: - items: type: integer type: array - type: 'null' title: Group Ids groups: anyOf: - additionalProperties: type: boolean type: object - type: 'null' title: Groups hidden: anyOf: - type: boolean - type: 'null' default: false title: Hidden id: anyOf: - type: integer - type: 'null' title: Id is_paused: anyOf: - type: boolean - type: 'null' default: false title: Is Paused last_test: anyOf: - $ref: '#/components/schemas/ApiDataSourceTestStatus' - type: 'null' lineage_schedule: anyOf: - type: string - type: 'null' title: Lineage Schedule max_allowed_connections: anyOf: - type: integer - type: 'null' title: Max Allowed Connections name: title: Name type: string oauth_dwh_active: anyOf: - type: boolean - type: 'null' title: Oauth Dwh Active options: anyOf: - $ref: '#/components/schemas/MySQLConfig' - type: 'null' profile_exclude_list: anyOf: - type: string - type: 'null' title: Profile Exclude List profile_include_list: anyOf: - type: string - type: 'null' title: Profile Include List profile_schedule: anyOf: - type: string - type: 'null' title: Profile Schedule queue_name: anyOf: - type: string - type: 'null' title: Queue Name scheduled_queue_name: anyOf: - type: string - type: 'null' title: Scheduled Queue Name schema_indexing_schedule: anyOf: - type: string - type: 'null' title: Schema Indexing Schedule schema_max_age_s: anyOf: - type: integer - type: 'null' title: Schema Max Age S secret_id: anyOf: - type: integer - type: 'null' title: Secret Id source: anyOf: - type: string - type: 'null' title: Source temp_schema: anyOf: - type: string - type: 'null' title: Temp Schema type: const: mysql title: Type type: string view_only: anyOf: - type: boolean - type: 'null' default: false title: View Only required: - name - type title: ApiDataSourceMySQL type: object ApiDataSourceNetezza: properties: accessible: default: true title: Accessible type: boolean catalog_exclude_list: anyOf: - type: string - type: 'null' title: Catalog Exclude List catalog_include_list: anyOf: - type: string - type: 'null' title: Catalog Include List created_from: anyOf: - type: string - type: 'null' title: Created From data_retention_days: anyOf: - type: integer - type: 'null' title: Data Retention Days disable_profiling: anyOf: - type: boolean - type: 'null' default: false title: Disable Profiling disable_schema_indexing: anyOf: - type: boolean - type: 'null' default: false title: Disable Schema Indexing float_tolerance: anyOf: - type: number - type: 'null' default: 0 title: Float Tolerance group_ids: anyOf: - items: type: integer type: array - type: 'null' title: Group Ids groups: anyOf: - additionalProperties: type: boolean type: object - type: 'null' title: Groups hidden: anyOf: - type: boolean - type: 'null' default: false title: Hidden id: anyOf: - type: integer - type: 'null' title: Id is_paused: anyOf: - type: boolean - type: 'null' default: false title: Is Paused last_test: anyOf: - $ref: '#/components/schemas/ApiDataSourceTestStatus' - type: 'null' lineage_schedule: anyOf: - type: string - type: 'null' title: Lineage Schedule max_allowed_connections: anyOf: - type: integer - type: 'null' title: Max Allowed Connections name: title: Name type: string oauth_dwh_active: anyOf: - type: boolean - type: 'null' title: Oauth Dwh Active options: anyOf: - $ref: '#/components/schemas/NetezzaConfig' - type: 'null' profile_exclude_list: anyOf: - type: string - type: 'null' title: Profile Exclude List profile_include_list: anyOf: - type: string - type: 'null' title: Profile Include List profile_schedule: anyOf: - type: string - type: 'null' title: Profile Schedule queue_name: anyOf: - type: string - type: 'null' title: Queue Name scheduled_queue_name: anyOf: - type: string - type: 'null' title: Scheduled Queue Name schema_indexing_schedule: anyOf: - type: string - type: 'null' title: Schema Indexing Schedule schema_max_age_s: anyOf: - type: integer - type: 'null' title: Schema Max Age S secret_id: anyOf: - type: integer - type: 'null' title: Secret Id source: anyOf: - type: string - type: 'null' title: Source temp_schema: anyOf: - type: string - type: 'null' title: Temp Schema type: const: netezza title: Type type: string view_only: anyOf: - type: boolean - type: 'null' default: false title: View Only required: - name - type title: ApiDataSourceNetezza type: object ApiDataSourceOracle: properties: accessible: default: true title: Accessible type: boolean catalog_exclude_list: anyOf: - type: string - type: 'null' title: Catalog Exclude List catalog_include_list: anyOf: - type: string - type: 'null' title: Catalog Include List created_from: anyOf: - type: string - type: 'null' title: Created From data_retention_days: anyOf: - type: integer - type: 'null' title: Data Retention Days disable_profiling: anyOf: - type: boolean - type: 'null' default: false title: Disable Profiling disable_schema_indexing: anyOf: - type: boolean - type: 'null' default: false title: Disable Schema Indexing float_tolerance: anyOf: - type: number - type: 'null' default: 0 title: Float Tolerance group_ids: anyOf: - items: type: integer type: array - type: 'null' title: Group Ids groups: anyOf: - additionalProperties: type: boolean type: object - type: 'null' title: Groups hidden: anyOf: - type: boolean - type: 'null' default: false title: Hidden id: anyOf: - type: integer - type: 'null' title: Id is_paused: anyOf: - type: boolean - type: 'null' default: false title: Is Paused last_test: anyOf: - $ref: '#/components/schemas/ApiDataSourceTestStatus' - type: 'null' lineage_schedule: anyOf: - type: string - type: 'null' title: Lineage Schedule max_allowed_connections: anyOf: - type: integer - type: 'null' title: Max Allowed Connections name: title: Name type: string oauth_dwh_active: anyOf: - type: boolean - type: 'null' title: Oauth Dwh Active options: anyOf: - $ref: '#/components/schemas/OracleConfig' - type: 'null' profile_exclude_list: anyOf: - type: string - type: 'null' title: Profile Exclude List profile_include_list: anyOf: - type: string - type: 'null' title: Profile Include List profile_schedule: anyOf: - type: string - type: 'null' title: Profile Schedule queue_name: anyOf: - type: string - type: 'null' title: Queue Name scheduled_queue_name: anyOf: - type: string - type: 'null' title: Scheduled Queue Name schema_indexing_schedule: anyOf: - type: string - type: 'null' title: Schema Indexing Schedule schema_max_age_s: anyOf: - type: integer - type: 'null' title: Schema Max Age S secret_id: anyOf: - type: integer - type: 'null' title: Secret Id source: anyOf: - type: string - type: 'null' title: Source temp_schema: anyOf: - type: string - type: 'null' title: Temp Schema type: const: oracle title: Type type: string view_only: anyOf: - type: boolean - type: 'null' default: false title: View Only required: - name - type title: ApiDataSourceOracle type: object ApiDataSourcePostgres: properties: accessible: default: true title: Accessible type: boolean catalog_exclude_list: anyOf: - type: string - type: 'null' title: Catalog Exclude List catalog_include_list: anyOf: - type: string - type: 'null' title: Catalog Include List created_from: anyOf: - type: string - type: 'null' title: Created From data_retention_days: anyOf: - type: integer - type: 'null' title: Data Retention Days disable_profiling: anyOf: - type: boolean - type: 'null' default: false title: Disable Profiling disable_schema_indexing: anyOf: - type: boolean - type: 'null' default: false title: Disable Schema Indexing float_tolerance: anyOf: - type: number - type: 'null' default: 0 title: Float Tolerance group_ids: anyOf: - items: type: integer type: array - type: 'null' title: Group Ids groups: anyOf: - additionalProperties: type: boolean type: object - type: 'null' title: Groups hidden: anyOf: - type: boolean - type: 'null' default: false title: Hidden id: anyOf: - type: integer - type: 'null' title: Id is_paused: anyOf: - type: boolean - type: 'null' default: false title: Is Paused last_test: anyOf: - $ref: '#/components/schemas/ApiDataSourceTestStatus' - type: 'null' lineage_schedule: anyOf: - type: string - type: 'null' title: Lineage Schedule max_allowed_connections: anyOf: - type: integer - type: 'null' title: Max Allowed Connections name: title: Name type: string oauth_dwh_active: anyOf: - type: boolean - type: 'null' title: Oauth Dwh Active options: anyOf: - $ref: '#/components/schemas/PostgreSQLConfig' - type: 'null' profile_exclude_list: anyOf: - type: string - type: 'null' title: Profile Exclude List profile_include_list: anyOf: - type: string - type: 'null' title: Profile Include List profile_schedule: anyOf: - type: string - type: 'null' title: Profile Schedule queue_name: anyOf: - type: string - type: 'null' title: Queue Name scheduled_queue_name: anyOf: - type: string - type: 'null' title: Scheduled Queue Name schema_indexing_schedule: anyOf: - type: string - type: 'null' title: Schema Indexing Schedule schema_max_age_s: anyOf: - type: integer - type: 'null' title: Schema Max Age S secret_id: anyOf: - type: integer - type: 'null' title: Secret Id source: anyOf: - type: string - type: 'null' title: Source temp_schema: anyOf: - type: string - type: 'null' title: Temp Schema type: const: pg title: Type type: string view_only: anyOf: - type: boolean - type: 'null' default: false title: View Only required: - name - type title: ApiDataSourcePostgres type: object ApiDataSourcePostgresAurora: properties: accessible: default: true title: Accessible type: boolean catalog_exclude_list: anyOf: - type: string - type: 'null' title: Catalog Exclude List catalog_include_list: anyOf: - type: string - type: 'null' title: Catalog Include List created_from: anyOf: - type: string - type: 'null' title: Created From data_retention_days: anyOf: - type: integer - type: 'null' title: Data Retention Days disable_profiling: anyOf: - type: boolean - type: 'null' default: false title: Disable Profiling disable_schema_indexing: anyOf: - type: boolean - type: 'null' default: false title: Disable Schema Indexing float_tolerance: anyOf: - type: number - type: 'null' default: 0 title: Float Tolerance group_ids: anyOf: - items: type: integer type: array - type: 'null' title: Group Ids groups: anyOf: - additionalProperties: type: boolean type: object - type: 'null' title: Groups hidden: anyOf: - type: boolean - type: 'null' default: false title: Hidden id: anyOf: - type: integer - type: 'null' title: Id is_paused: anyOf: - type: boolean - type: 'null' default: false title: Is Paused last_test: anyOf: - $ref: '#/components/schemas/ApiDataSourceTestStatus' - type: 'null' lineage_schedule: anyOf: - type: string - type: 'null' title: Lineage Schedule max_allowed_connections: anyOf: - type: integer - type: 'null' title: Max Allowed Connections name: title: Name type: string oauth_dwh_active: anyOf: - type: boolean - type: 'null' title: Oauth Dwh Active options: anyOf: - $ref: '#/components/schemas/PostgreSQLAuroraConfig' - type: 'null' profile_exclude_list: anyOf: - type: string - type: 'null' title: Profile Exclude List profile_include_list: anyOf: - type: string - type: 'null' title: Profile Include List profile_schedule: anyOf: - type: string - type: 'null' title: Profile Schedule queue_name: anyOf: - type: string - type: 'null' title: Queue Name scheduled_queue_name: anyOf: - type: string - type: 'null' title: Scheduled Queue Name schema_indexing_schedule: anyOf: - type: string - type: 'null' title: Schema Indexing Schedule schema_max_age_s: anyOf: - type: integer - type: 'null' title: Schema Max Age S secret_id: anyOf: - type: integer - type: 'null' title: Secret Id source: anyOf: - type: string - type: 'null' title: Source temp_schema: anyOf: - type: string - type: 'null' title: Temp Schema type: const: postgres_aurora title: Type type: string view_only: anyOf: - type: boolean - type: 'null' default: false title: View Only required: - name - type title: ApiDataSourcePostgresAurora type: object ApiDataSourcePostgresRds: properties: accessible: default: true title: Accessible type: boolean catalog_exclude_list: anyOf: - type: string - type: 'null' title: Catalog Exclude List catalog_include_list: anyOf: - type: string - type: 'null' title: Catalog Include List created_from: anyOf: - type: string - type: 'null' title: Created From data_retention_days: anyOf: - type: integer - type: 'null' title: Data Retention Days disable_profiling: anyOf: - type: boolean - type: 'null' default: false title: Disable Profiling disable_schema_indexing: anyOf: - type: boolean - type: 'null' default: false title: Disable Schema Indexing float_tolerance: anyOf: - type: number - type: 'null' default: 0 title: Float Tolerance group_ids: anyOf: - items: type: integer type: array - type: 'null' title: Group Ids groups: anyOf: - additionalProperties: type: boolean type: object - type: 'null' title: Groups hidden: anyOf: - type: boolean - type: 'null' default: false title: Hidden id: anyOf: - type: integer - type: 'null' title: Id is_paused: anyOf: - type: boolean - type: 'null' default: false title: Is Paused last_test: anyOf: - $ref: '#/components/schemas/ApiDataSourceTestStatus' - type: 'null' lineage_schedule: anyOf: - type: string - type: 'null' title: Lineage Schedule max_allowed_connections: anyOf: - type: integer - type: 'null' title: Max Allowed Connections name: title: Name type: string oauth_dwh_active: anyOf: - type: boolean - type: 'null' title: Oauth Dwh Active options: anyOf: - $ref: '#/components/schemas/PostgreSQLAuroraConfig' - type: 'null' profile_exclude_list: anyOf: - type: string - type: 'null' title: Profile Exclude List profile_include_list: anyOf: - type: string - type: 'null' title: Profile Include List profile_schedule: anyOf: - type: string - type: 'null' title: Profile Schedule queue_name: anyOf: - type: string - type: 'null' title: Queue Name scheduled_queue_name: anyOf: - type: string - type: 'null' title: Scheduled Queue Name schema_indexing_schedule: anyOf: - type: string - type: 'null' title: Schema Indexing Schedule schema_max_age_s: anyOf: - type: integer - type: 'null' title: Schema Max Age S secret_id: anyOf: - type: integer - type: 'null' title: Secret Id source: anyOf: - type: string - type: 'null' title: Source temp_schema: anyOf: - type: string - type: 'null' title: Temp Schema type: const: postgres_aws_rds title: Type type: string view_only: anyOf: - type: boolean - type: 'null' default: false title: View Only required: - name - type title: ApiDataSourcePostgresRds type: object ApiDataSourceRedshift: properties: accessible: default: true title: Accessible type: boolean catalog_exclude_list: anyOf: - type: string - type: 'null' title: Catalog Exclude List catalog_include_list: anyOf: - type: string - type: 'null' title: Catalog Include List created_from: anyOf: - type: string - type: 'null' title: Created From data_retention_days: anyOf: - type: integer - type: 'null' title: Data Retention Days disable_profiling: anyOf: - type: boolean - type: 'null' default: false title: Disable Profiling disable_schema_indexing: anyOf: - type: boolean - type: 'null' default: false title: Disable Schema Indexing float_tolerance: anyOf: - type: number - type: 'null' default: 0 title: Float Tolerance group_ids: anyOf: - items: type: integer type: array - type: 'null' title: Group Ids groups: anyOf: - additionalProperties: type: boolean type: object - type: 'null' title: Groups hidden: anyOf: - type: boolean - type: 'null' default: false title: Hidden id: anyOf: - type: integer - type: 'null' title: Id is_paused: anyOf: - type: boolean - type: 'null' default: false title: Is Paused last_test: anyOf: - $ref: '#/components/schemas/ApiDataSourceTestStatus' - type: 'null' lineage_schedule: anyOf: - type: string - type: 'null' title: Lineage Schedule max_allowed_connections: anyOf: - type: integer - type: 'null' title: Max Allowed Connections name: title: Name type: string oauth_dwh_active: anyOf: - type: boolean - type: 'null' title: Oauth Dwh Active options: anyOf: - $ref: '#/components/schemas/RedshiftConfig' - type: 'null' profile_exclude_list: anyOf: - type: string - type: 'null' title: Profile Exclude List profile_include_list: anyOf: - type: string - type: 'null' title: Profile Include List profile_schedule: anyOf: - type: string - type: 'null' title: Profile Schedule queue_name: anyOf: - type: string - type: 'null' title: Queue Name scheduled_queue_name: anyOf: - type: string - type: 'null' title: Scheduled Queue Name schema_indexing_schedule: anyOf: - type: string - type: 'null' title: Schema Indexing Schedule schema_max_age_s: anyOf: - type: integer - type: 'null' title: Schema Max Age S secret_id: anyOf: - type: integer - type: 'null' title: Secret Id source: anyOf: - type: string - type: 'null' title: Source temp_schema: anyOf: - type: string - type: 'null' title: Temp Schema type: const: redshift title: Type type: string view_only: anyOf: - type: boolean - type: 'null' default: false title: View Only required: - name - type title: ApiDataSourceRedshift type: object ApiDataSourceSapHana: properties: accessible: default: true title: Accessible type: boolean catalog_exclude_list: anyOf: - type: string - type: 'null' title: Catalog Exclude List catalog_include_list: anyOf: - type: string - type: 'null' title: Catalog Include List created_from: anyOf: - type: string - type: 'null' title: Created From data_retention_days: anyOf: - type: integer - type: 'null' title: Data Retention Days disable_profiling: anyOf: - type: boolean - type: 'null' default: false title: Disable Profiling disable_schema_indexing: anyOf: - type: boolean - type: 'null' default: false title: Disable Schema Indexing float_tolerance: anyOf: - type: number - type: 'null' default: 0 title: Float Tolerance group_ids: anyOf: - items: type: integer type: array - type: 'null' title: Group Ids groups: anyOf: - additionalProperties: type: boolean type: object - type: 'null' title: Groups hidden: anyOf: - type: boolean - type: 'null' default: false title: Hidden id: anyOf: - type: integer - type: 'null' title: Id is_paused: anyOf: - type: boolean - type: 'null' default: false title: Is Paused last_test: anyOf: - $ref: '#/components/schemas/ApiDataSourceTestStatus' - type: 'null' lineage_schedule: anyOf: - type: string - type: 'null' title: Lineage Schedule max_allowed_connections: anyOf: - type: integer - type: 'null' title: Max Allowed Connections name: title: Name type: string oauth_dwh_active: anyOf: - type: boolean - type: 'null' title: Oauth Dwh Active options: anyOf: - $ref: '#/components/schemas/SapHanaConfig' - type: 'null' profile_exclude_list: anyOf: - type: string - type: 'null' title: Profile Exclude List profile_include_list: anyOf: - type: string - type: 'null' title: Profile Include List profile_schedule: anyOf: - type: string - type: 'null' title: Profile Schedule queue_name: anyOf: - type: string - type: 'null' title: Queue Name scheduled_queue_name: anyOf: - type: string - type: 'null' title: Scheduled Queue Name schema_indexing_schedule: anyOf: - type: string - type: 'null' title: Schema Indexing Schedule schema_max_age_s: anyOf: - type: integer - type: 'null' title: Schema Max Age S secret_id: anyOf: - type: integer - type: 'null' title: Secret Id source: anyOf: - type: string - type: 'null' title: Source temp_schema: anyOf: - type: string - type: 'null' title: Temp Schema type: const: sap_hana title: Type type: string view_only: anyOf: - type: boolean - type: 'null' default: false title: View Only required: - name - type title: ApiDataSourceSapHana type: object ApiDataSourceSnowflake: properties: accessible: default: true title: Accessible type: boolean catalog_exclude_list: anyOf: - type: string - type: 'null' title: Catalog Exclude List catalog_include_list: anyOf: - type: string - type: 'null' title: Catalog Include List created_from: anyOf: - type: string - type: 'null' title: Created From data_retention_days: anyOf: - type: integer - type: 'null' title: Data Retention Days disable_profiling: anyOf: - type: boolean - type: 'null' default: false title: Disable Profiling disable_schema_indexing: anyOf: - type: boolean - type: 'null' default: false title: Disable Schema Indexing float_tolerance: anyOf: - type: number - type: 'null' default: 0 title: Float Tolerance group_ids: anyOf: - items: type: integer type: array - type: 'null' title: Group Ids groups: anyOf: - additionalProperties: type: boolean type: object - type: 'null' title: Groups hidden: anyOf: - type: boolean - type: 'null' default: false title: Hidden id: anyOf: - type: integer - type: 'null' title: Id is_paused: anyOf: - type: boolean - type: 'null' default: false title: Is Paused last_test: anyOf: - $ref: '#/components/schemas/ApiDataSourceTestStatus' - type: 'null' lineage_schedule: anyOf: - type: string - type: 'null' title: Lineage Schedule max_allowed_connections: anyOf: - type: integer - type: 'null' title: Max Allowed Connections name: title: Name type: string oauth_dwh_active: anyOf: - type: boolean - type: 'null' title: Oauth Dwh Active options: anyOf: - $ref: '#/components/schemas/SnowflakeConfig' - type: 'null' profile_exclude_list: anyOf: - type: string - type: 'null' title: Profile Exclude List profile_include_list: anyOf: - type: string - type: 'null' title: Profile Include List profile_schedule: anyOf: - type: string - type: 'null' title: Profile Schedule queue_name: anyOf: - type: string - type: 'null' title: Queue Name scheduled_queue_name: anyOf: - type: string - type: 'null' title: Scheduled Queue Name schema_indexing_schedule: anyOf: - type: string - type: 'null' title: Schema Indexing Schedule schema_max_age_s: anyOf: - type: integer - type: 'null' title: Schema Max Age S secret_id: anyOf: - type: integer - type: 'null' title: Secret Id source: anyOf: - type: string - type: 'null' title: Source temp_schema: anyOf: - type: string - type: 'null' title: Temp Schema type: const: snowflake title: Type type: string view_only: anyOf: - type: boolean - type: 'null' default: false title: View Only required: - name - type title: ApiDataSourceSnowflake type: object ApiDataSourceStarburst: properties: accessible: default: true title: Accessible type: boolean catalog_exclude_list: anyOf: - type: string - type: 'null' title: Catalog Exclude List catalog_include_list: anyOf: - type: string - type: 'null' title: Catalog Include List created_from: anyOf: - type: string - type: 'null' title: Created From data_retention_days: anyOf: - type: integer - type: 'null' title: Data Retention Days disable_profiling: anyOf: - type: boolean - type: 'null' default: false title: Disable Profiling disable_schema_indexing: anyOf: - type: boolean - type: 'null' default: false title: Disable Schema Indexing float_tolerance: anyOf: - type: number - type: 'null' default: 0 title: Float Tolerance group_ids: anyOf: - items: type: integer type: array - type: 'null' title: Group Ids groups: anyOf: - additionalProperties: type: boolean type: object - type: 'null' title: Groups hidden: anyOf: - type: boolean - type: 'null' default: false title: Hidden id: anyOf: - type: integer - type: 'null' title: Id is_paused: anyOf: - type: boolean - type: 'null' default: false title: Is Paused last_test: anyOf: - $ref: '#/components/schemas/ApiDataSourceTestStatus' - type: 'null' lineage_schedule: anyOf: - type: string - type: 'null' title: Lineage Schedule max_allowed_connections: anyOf: - type: integer - type: 'null' title: Max Allowed Connections name: title: Name type: string oauth_dwh_active: anyOf: - type: boolean - type: 'null' title: Oauth Dwh Active options: anyOf: - $ref: '#/components/schemas/StarburstConfig' - type: 'null' profile_exclude_list: anyOf: - type: string - type: 'null' title: Profile Exclude List profile_include_list: anyOf: - type: string - type: 'null' title: Profile Include List profile_schedule: anyOf: - type: string - type: 'null' title: Profile Schedule queue_name: anyOf: - type: string - type: 'null' title: Queue Name scheduled_queue_name: anyOf: - type: string - type: 'null' title: Scheduled Queue Name schema_indexing_schedule: anyOf: - type: string - type: 'null' title: Schema Indexing Schedule schema_max_age_s: anyOf: - type: integer - type: 'null' title: Schema Max Age S secret_id: anyOf: - type: integer - type: 'null' title: Secret Id source: anyOf: - type: string - type: 'null' title: Source temp_schema: anyOf: - type: string - type: 'null' title: Temp Schema type: const: starburst title: Type type: string view_only: anyOf: - type: boolean - type: 'null' default: false title: View Only required: - name - type title: ApiDataSourceStarburst type: object ApiDataSourceTeradata: properties: accessible: default: true title: Accessible type: boolean catalog_exclude_list: anyOf: - type: string - type: 'null' title: Catalog Exclude List catalog_include_list: anyOf: - type: string - type: 'null' title: Catalog Include List created_from: anyOf: - type: string - type: 'null' title: Created From data_retention_days: anyOf: - type: integer - type: 'null' title: Data Retention Days disable_profiling: anyOf: - type: boolean - type: 'null' default: false title: Disable Profiling disable_schema_indexing: anyOf: - type: boolean - type: 'null' default: false title: Disable Schema Indexing float_tolerance: anyOf: - type: number - type: 'null' default: 0 title: Float Tolerance group_ids: anyOf: - items: type: integer type: array - type: 'null' title: Group Ids groups: anyOf: - additionalProperties: type: boolean type: object - type: 'null' title: Groups hidden: anyOf: - type: boolean - type: 'null' default: false title: Hidden id: anyOf: - type: integer - type: 'null' title: Id is_paused: anyOf: - type: boolean - type: 'null' default: false title: Is Paused last_test: anyOf: - $ref: '#/components/schemas/ApiDataSourceTestStatus' - type: 'null' lineage_schedule: anyOf: - type: string - type: 'null' title: Lineage Schedule max_allowed_connections: anyOf: - type: integer - type: 'null' title: Max Allowed Connections name: title: Name type: string oauth_dwh_active: anyOf: - type: boolean - type: 'null' title: Oauth Dwh Active options: anyOf: - $ref: '#/components/schemas/TeradataConfig' - type: 'null' profile_exclude_list: anyOf: - type: string - type: 'null' title: Profile Exclude List profile_include_list: anyOf: - type: string - type: 'null' title: Profile Include List profile_schedule: anyOf: - type: string - type: 'null' title: Profile Schedule queue_name: anyOf: - type: string - type: 'null' title: Queue Name scheduled_queue_name: anyOf: - type: string - type: 'null' title: Scheduled Queue Name schema_indexing_schedule: anyOf: - type: string - type: 'null' title: Schema Indexing Schedule schema_max_age_s: anyOf: - type: integer - type: 'null' title: Schema Max Age S secret_id: anyOf: - type: integer - type: 'null' title: Secret Id source: anyOf: - type: string - type: 'null' title: Source temp_schema: anyOf: - type: string - type: 'null' title: Temp Schema type: const: teradata title: Type type: string view_only: anyOf: - type: boolean - type: 'null' default: false title: View Only required: - name - type title: ApiDataSourceTeradata type: object ApiDataSourceTrino: properties: accessible: default: true title: Accessible type: boolean catalog_exclude_list: anyOf: - type: string - type: 'null' title: Catalog Exclude List catalog_include_list: anyOf: - type: string - type: 'null' title: Catalog Include List created_from: anyOf: - type: string - type: 'null' title: Created From data_retention_days: anyOf: - type: integer - type: 'null' title: Data Retention Days disable_profiling: anyOf: - type: boolean - type: 'null' default: false title: Disable Profiling disable_schema_indexing: anyOf: - type: boolean - type: 'null' default: false title: Disable Schema Indexing float_tolerance: anyOf: - type: number - type: 'null' default: 0 title: Float Tolerance group_ids: anyOf: - items: type: integer type: array - type: 'null' title: Group Ids groups: anyOf: - additionalProperties: type: boolean type: object - type: 'null' title: Groups hidden: anyOf: - type: boolean - type: 'null' default: false title: Hidden id: anyOf: - type: integer - type: 'null' title: Id is_paused: anyOf: - type: boolean - type: 'null' default: false title: Is Paused last_test: anyOf: - $ref: '#/components/schemas/ApiDataSourceTestStatus' - type: 'null' lineage_schedule: anyOf: - type: string - type: 'null' title: Lineage Schedule max_allowed_connections: anyOf: - type: integer - type: 'null' title: Max Allowed Connections name: title: Name type: string oauth_dwh_active: anyOf: - type: boolean - type: 'null' title: Oauth Dwh Active options: anyOf: - $ref: '#/components/schemas/TrinoConfig' - type: 'null' profile_exclude_list: anyOf: - type: string - type: 'null' title: Profile Exclude List profile_include_list: anyOf: - type: string - type: 'null' title: Profile Include List profile_schedule: anyOf: - type: string - type: 'null' title: Profile Schedule queue_name: anyOf: - type: string - type: 'null' title: Queue Name scheduled_queue_name: anyOf: - type: string - type: 'null' title: Scheduled Queue Name schema_indexing_schedule: anyOf: - type: string - type: 'null' title: Schema Indexing Schedule schema_max_age_s: anyOf: - type: integer - type: 'null' title: Schema Max Age S secret_id: anyOf: - type: integer - type: 'null' title: Secret Id source: anyOf: - type: string - type: 'null' title: Source temp_schema: anyOf: - type: string - type: 'null' title: Temp Schema type: const: trino title: Type type: string view_only: anyOf: - type: boolean - type: 'null' default: false title: View Only required: - name - type title: ApiDataSourceTrino type: object ApiDataSourceVertica: properties: accessible: default: true title: Accessible type: boolean catalog_exclude_list: anyOf: - type: string - type: 'null' title: Catalog Exclude List catalog_include_list: anyOf: - type: string - type: 'null' title: Catalog Include List created_from: anyOf: - type: string - type: 'null' title: Created From data_retention_days: anyOf: - type: integer - type: 'null' title: Data Retention Days disable_profiling: anyOf: - type: boolean - type: 'null' default: false title: Disable Profiling disable_schema_indexing: anyOf: - type: boolean - type: 'null' default: false title: Disable Schema Indexing float_tolerance: anyOf: - type: number - type: 'null' default: 0 title: Float Tolerance group_ids: anyOf: - items: type: integer type: array - type: 'null' title: Group Ids groups: anyOf: - additionalProperties: type: boolean type: object - type: 'null' title: Groups hidden: anyOf: - type: boolean - type: 'null' default: false title: Hidden id: anyOf: - type: integer - type: 'null' title: Id is_paused: anyOf: - type: boolean - type: 'null' default: false title: Is Paused last_test: anyOf: - $ref: '#/components/schemas/ApiDataSourceTestStatus' - type: 'null' lineage_schedule: anyOf: - type: string - type: 'null' title: Lineage Schedule max_allowed_connections: anyOf: - type: integer - type: 'null' title: Max Allowed Connections name: title: Name type: string oauth_dwh_active: anyOf: - type: boolean - type: 'null' title: Oauth Dwh Active options: anyOf: - $ref: '#/components/schemas/VerticaConfig' - type: 'null' profile_exclude_list: anyOf: - type: string - type: 'null' title: Profile Exclude List profile_include_list: anyOf: - type: string - type: 'null' title: Profile Include List profile_schedule: anyOf: - type: string - type: 'null' title: Profile Schedule queue_name: anyOf: - type: string - type: 'null' title: Queue Name scheduled_queue_name: anyOf: - type: string - type: 'null' title: Scheduled Queue Name schema_indexing_schedule: anyOf: - type: string - type: 'null' title: Schema Indexing Schedule schema_max_age_s: anyOf: - type: integer - type: 'null' title: Schema Max Age S secret_id: anyOf: - type: integer - type: 'null' title: Secret Id source: anyOf: - type: string - type: 'null' title: Source temp_schema: anyOf: - type: string - type: 'null' title: Temp Schema type: const: vertica title: Type type: string view_only: anyOf: - type: boolean - type: 'null' default: false title: View Only required: - name - type title: ApiDataSourceVertica type: object HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' title: Detail type: array title: HTTPValidationError type: object ApiDataSourceTestStatus: properties: results: items: $ref: '#/components/schemas/TestResultStep' title: Results type: array tested_at: format: date-time title: Tested At type: string required: - tested_at - results title: ApiDataSourceTestStatus type: object AwsAthenaConfig: properties: aws_access_key_id: title: Aws Access Key Id type: string aws_secret_access_key: format: password title: Aws Secret Access Key type: string writeOnly: true catalog: default: awsdatacatalog title: Catalog type: string database: default: default title: Database type: string region: title: Region type: string s3_staging_dir: title: S3 Staging Dir type: string required: - aws_access_key_id - aws_secret_access_key - s3_staging_dir - region title: AwsAthenaConfig type: object AWSS3Config: properties: bucket_name: title: Bucket Name type: string key_id: anyOf: - maxLength: 1024 type: string - type: 'null' title: Key Id materialize_max_rows: anyOf: - type: integer - type: 'null' title: Materialize Max Rows materialize_path: anyOf: - type: string - type: 'null' title: Materialize Path region: title: Region type: string secret: anyOf: - format: password type: string writeOnly: true - type: 'null' title: Secret required: - bucket_name - key_id - region title: AWSS3Config type: object MSSQLConfig: properties: always_on: default: false title: Always On type: boolean dbname: anyOf: - type: string - type: 'null' title: Dbname host: maxLength: 128 title: Host type: string password: anyOf: - format: password type: string writeOnly: true - type: 'null' title: Password port: default: 1433 title: Port type: integer require_encryption: default: true title: Require Encryption type: boolean session_script: anyOf: - type: string - type: 'null' description: >- The script to execute on connection; e.g. ALTER SESSION SET CONTAINER = ... title: Init script trust_server_certificate: default: true title: Trust Server Certificate type: boolean user: default: DATAFOLD title: User type: string required: - host title: MSSQLConfig type: object BigQueryConfig: properties: extraProjectsToIndex: anyOf: - type: string - type: 'null' examples: - |- project1 project2 section: config title: List of extra projects to index (one per line) widget: multiline jsonKeyFile: format: password section: basic title: JSON Key File type: string writeOnly: true jsonOAuthKeyFile: anyOf: - format: password type: string writeOnly: true - type: 'null' section: basic title: JSON OAuth Key File location: default: US examples: - US section: basic title: Processing Location type: string projectId: section: basic title: Project ID type: string totalMBytesProcessedLimit: anyOf: - type: integer - type: 'null' section: config title: Scanned Data Limit (MB) useStandardSql: default: true section: config title: Use Standard SQL type: boolean userDefinedFunctionResourceUri: anyOf: - type: string - type: 'null' examples: - gs://bucket/date_utils.js section: config title: UDF Source URIs required: - projectId - jsonKeyFile title: BigQueryConfig type: object DatabricksConfig: properties: auth_method: anyOf: - enum: - pat - m2m_oauth type: string - type: 'null' title: Auth Method database: anyOf: - type: string - type: 'null' title: Database host: maxLength: 128 title: Host type: string http_password: anyOf: - format: password type: string writeOnly: true - type: 'null' title: Access Token http_path: default: '' title: HTTP Path type: string m2m_client_id: anyOf: - type: string - type: 'null' title: M2M Client Id m2m_client_secret: anyOf: - format: password type: string writeOnly: true - type: 'null' title: Client Secret oauth_dwh_client_id: anyOf: - type: string - type: 'null' title: Oauth Dwh Client Id oauth_dwh_client_secret: anyOf: - format: password type: string writeOnly: true - type: 'null' title: Oauth Dwh Client Secret required: - host title: DatabricksConfig type: object DB2Config: description: Configuration for IBM DB2 database connection. properties: connection_timeout: default: 30 description: Connection timeout in seconds title: Connection Timeout type: integer current_schema: anyOf: - type: string - type: 'null' description: Default schema to use (SET CURRENT SCHEMA) title: Current Schema dbname: description: Database name title: Dbname type: string host: description: DB2 server hostname maxLength: 128 title: Host type: string password: description: Database password format: password title: Password type: string writeOnly: true pool_size: default: 1 description: Number of connections in pool title: Pool Size type: integer port: default: 50000 description: DB2 server port title: Port type: integer ssl: default: false description: Enable SSL connection title: Ssl type: boolean ssl_certificate: anyOf: - format: password type: string writeOnly: true - type: 'null' description: SSL server certificate (PEM format or file path) title: Ssl Certificate user: description: Database username title: User type: string required: - host - dbname - user - password title: DB2Config type: object DremioConfig: properties: certcheck: anyOf: - $ref: '#/components/schemas/CertCheck' - type: 'null' default: dremio-cloud title: Certificate check customcert: anyOf: - format: password type: string writeOnly: true - type: 'null' title: Custom certificate host: maxLength: 128 title: Host type: string password: anyOf: - format: password type: string writeOnly: true - type: 'null' title: Password port: default: 443 title: Port type: integer project_id: anyOf: - type: string - type: 'null' title: Project id role: anyOf: - type: string - type: 'null' title: Role (case sensitive) tls: default: false title: Encryption type: boolean token: anyOf: - format: password type: string writeOnly: true - type: 'null' title: Token username: anyOf: - type: string - type: 'null' title: User ID (optional) view_temp_schema: anyOf: - type: string - type: 'null' title: Temporary schema for views required: - host title: DremioConfig type: object DuckDBConfig: properties: {} title: DuckDBConfig type: object AzureDataLakeConfig: properties: account_name: title: Account Name type: string client_id: anyOf: - maxLength: 1024 type: string - type: 'null' title: Client Id client_secret: anyOf: - format: password type: string writeOnly: true - type: 'null' title: Client Secret materialize_max_rows: anyOf: - type: integer - type: 'null' title: Materialize Max Rows materialize_path: anyOf: - type: string - type: 'null' title: Materialize Path tenant_id: anyOf: - maxLength: 1024 type: string - type: 'null' title: Tenant Id required: - account_name - tenant_id - client_id title: AzureDataLakeConfig type: object GCSConfig: properties: bucket_name: title: Bucket Name type: string bucket_region: title: Bucket Region type: string jsonKeyFile: format: password section: basic title: JSON Key File type: string writeOnly: true materialize_max_rows: anyOf: - type: integer - type: 'null' title: Materialize Max Rows materialize_path: anyOf: - type: string - type: 'null' title: Materialize Path required: - bucket_name - jsonKeyFile - bucket_region title: GCSConfig type: object MariaDBConfig: description: |- Configuration for MariaDB connections. MariaDB is MySQL-compatible, so we reuse the MySQL configuration. Default port is 3306, same as MySQL. properties: db: title: Database name type: string host: maxLength: 128 title: Host type: string password: format: password title: Password type: string writeOnly: true port: default: 3306 title: Port type: integer user: title: User type: string required: - host - user - password - db title: MariaDBConfig type: object MicrosoftFabricConfig: properties: client_id: description: Microsoft Entra ID Application (Client) ID title: Application (Client) ID type: string client_secret: description: Microsoft Entra ID Application Client Secret format: password title: Client Secret type: string writeOnly: true dbname: title: Dbname type: string host: maxLength: 128 title: Host type: string session_script: anyOf: - type: string - type: 'null' description: >- The script to execute on connection; e.g. ALTER SESSION SET CONTAINER = ... title: Init script tenant_id: description: Microsoft Entra ID Tenant ID title: Tenant ID type: string required: - host - dbname - tenant_id - client_id - client_secret title: MicrosoftFabricConfig type: object MongoDBConfig: properties: auth_source: anyOf: - type: string - type: 'null' default: admin title: Auth Source connect_timeout_ms: default: 60000 title: Connect Timeout Ms type: integer database: title: Database type: string host: maxLength: 128 title: Host type: string password: format: password title: Password type: string writeOnly: true port: default: 27017 title: Port type: integer server_selection_timeout_ms: default: 60000 title: Server Selection Timeout Ms type: integer socket_timeout_ms: default: 300000 title: Socket Timeout Ms type: integer username: title: Username type: string required: - database - username - password - host title: MongoDBConfig type: object MySQLConfig: properties: db: title: Database name type: string host: maxLength: 128 title: Host type: string password: format: password title: Password type: string writeOnly: true port: default: 3306 title: Port type: integer user: title: User type: string required: - host - user - password - db title: MySQLConfig type: object NetezzaConfig: properties: database: maxLength: 128 title: Database type: string host: maxLength: 128 title: Host type: string password: anyOf: - format: password type: string writeOnly: true - type: 'null' title: Password port: default: 5480 title: Port type: integer tls: default: true title: Encryption type: boolean username: anyOf: - type: string - type: 'null' title: User ID (optional) required: - host - database title: NetezzaConfig type: object OracleConfig: properties: database: anyOf: - type: string - type: 'null' title: Database database_type: anyOf: - enum: - service - sid type: string - type: 'null' title: Database Type ewallet_password: anyOf: - format: password type: string writeOnly: true - type: 'null' title: EWallet password ewallet_pem_file: anyOf: - format: password type: string writeOnly: true - type: 'null' title: EWallet PEM ewallet_pkcs12_file: anyOf: - format: password type: string writeOnly: true - type: 'null' title: EWallet PKCS12 ewallet_type: anyOf: - enum: - x509 - pkcs12 type: string - type: 'null' title: Ewallet Type host: maxLength: 128 title: Host type: string password: anyOf: - format: password type: string writeOnly: true - type: 'null' title: Password port: anyOf: - type: integer - type: 'null' title: Port session_script: anyOf: - type: string - type: 'null' description: >- The script to execute on connection; e.g. ALTER SESSION SET CONTAINER = ... title: Init script ssl: default: false title: Ssl type: boolean ssl_server_dn: anyOf: - type: string - type: 'null' description: 'e.g. C=US,O=example,CN=db.example.com; default: CN=' title: Server's SSL DN user: default: DATAFOLD title: User type: string required: - host title: OracleConfig type: object PostgreSQLConfig: properties: dbname: title: Database Name type: string host: maxLength: 128 title: Host type: string password: anyOf: - format: password type: string writeOnly: true - type: 'null' title: Password port: default: 5432 title: Port type: integer role: anyOf: - type: string - type: 'null' title: Role (case sensitive) rootcert: anyOf: - format: password type: string writeOnly: true - type: 'null' title: Root certificate sslmode: $ref: '#/components/schemas/SslMode' default: prefer title: SSL Mode user: title: User type: string required: - host - user - dbname title: PostgreSQLConfig type: object PostgreSQLAuroraConfig: properties: aws_access_key_id: anyOf: - type: string - type: 'null' title: AWS Access Key aws_cloudwatch_log_group: anyOf: - type: string - type: 'null' title: Cloudwatch Postgres Log Group aws_region: anyOf: - type: string - type: 'null' title: AWS Region aws_secret_access_key: anyOf: - format: password type: string writeOnly: true - type: 'null' title: AWS Secret dbname: title: Database Name type: string host: maxLength: 128 title: Host type: string keep_alive: anyOf: - type: integer - type: 'null' title: Keep Alive timeout in seconds, leave empty to disable password: anyOf: - format: password type: string writeOnly: true - type: 'null' title: Password port: default: 5432 title: Port type: integer role: anyOf: - type: string - type: 'null' title: Role (case sensitive) rootcert: anyOf: - format: password type: string writeOnly: true - type: 'null' title: Root certificate sslmode: $ref: '#/components/schemas/SslMode' default: prefer title: SSL Mode user: title: User type: string required: - host - user - dbname title: PostgreSQLAuroraConfig type: object RedshiftConfig: properties: adhoc_query_group: default: default section: config title: Query Group for Adhoc Queries type: string dbname: title: Database Name type: string host: maxLength: 128 title: Host type: string password: anyOf: - format: password type: string writeOnly: true - type: 'null' title: Password port: default: 5432 title: Port type: integer role: anyOf: - type: string - type: 'null' title: Role (case sensitive) rootcert: anyOf: - format: password type: string writeOnly: true - type: 'null' title: Root certificate scheduled_query_group: default: default section: config title: Query Group for Scheduled Queries type: string sslmode: $ref: '#/components/schemas/SslMode' default: prefer title: SSL Mode user: title: User type: string required: - host - user - dbname title: RedshiftConfig type: object SapHanaConfig: properties: host: maxLength: 128 title: Host type: string password: format: password title: Password type: string writeOnly: true port: default: 443 title: Port type: integer user: default: DATAFOLD title: User type: string required: - host - password title: SapHanaConfig type: object SnowflakeConfig: properties: account: maxLength: 128 title: Account type: string authMethod: anyOf: - enum: - password - keypair type: string - type: 'null' title: Authmethod data_source_id: anyOf: - type: integer - type: 'null' title: Data Source Id default_db: default: '' examples: - MY_DB title: Default DB (case sensitive) type: string default_schema: default: PUBLIC examples: - PUBLIC section: config title: Default schema (case sensitive) type: string keyPairFile: anyOf: - format: password type: string writeOnly: true - type: 'null' title: Key Pair file (private-key) metadata_database: default: SNOWFLAKE examples: - SNOWFLAKE section: config title: Database containing metadata (usually SNOWFLAKE) type: string oauth_dwh_client_id: anyOf: - type: string - type: 'null' title: Oauth Dwh Client Id oauth_dwh_client_secret: anyOf: - format: password type: string writeOnly: true - type: 'null' title: Oauth Dwh Client Secret password: anyOf: - format: password type: string writeOnly: true - type: 'null' title: Password port: anyOf: - type: integer - type: 'null' default: 443 title: Port quoted_identifiers_ignore_case: default: false section: config title: Set QUOTED_IDENTIFIERS_IGNORE_CASE session parameter type: boolean region: anyOf: - type: string - type: 'null' section: config title: Region role: default: '' examples: - PUBLIC title: Role (case sensitive) type: string sql_variables: anyOf: - type: string - type: 'null' examples: - |- variable_1=10 variable_2=test section: config title: Session variables applied at every connection. widget: multiline user: default: DATAFOLD title: User type: string user_id: anyOf: - type: integer - type: 'null' title: User Id warehouse: default: '' examples: - COMPUTE_WH title: Warehouse (case sensitive) type: string required: - account title: SnowflakeConfig type: object StarburstConfig: properties: host: maxLength: 128 title: Host type: string password: anyOf: - format: password type: string writeOnly: true - type: 'null' title: Password port: default: 443 title: Port type: integer tls: default: true title: Encryption type: boolean token: anyOf: - format: password type: string writeOnly: true - type: 'null' title: Token username: anyOf: - type: string - type: 'null' title: User ID (optional) required: - host title: StarburstConfig type: object TeradataConfig: properties: database: title: Database type: string host: maxLength: 128 title: Host type: string password: format: password title: Password type: string writeOnly: true port: anyOf: - type: integer - type: 'null' title: Port user: default: DATAFOLD title: User type: string required: - host - password - database title: TeradataConfig type: object TrinoConfig: properties: dbname: title: Catalog Name type: string hive_timestamp_precision: anyOf: - enum: - 3 - 6 - 9 type: integer - type: 'null' description: 'Optional: Timestamp precision if using Hive connector' title: Hive Timestamp Precision host: maxLength: 128 title: Host type: string password: anyOf: - format: password type: string writeOnly: true - type: 'null' title: Password port: default: 8080 title: Port type: integer ssl_verification: $ref: '#/components/schemas/SSLVerification' default: full title: SSL Verification tls: default: true title: Encryption type: boolean user: title: User type: string required: - host - user - dbname title: TrinoConfig type: object VerticaConfig: properties: dbname: title: Database Name type: string host: maxLength: 128 title: Host type: string password: anyOf: - format: password type: string writeOnly: true - type: 'null' title: Password port: default: 5433 title: Port type: integer role: anyOf: - type: string - type: 'null' title: Role (case sensitive) sslmode: $ref: '#/components/schemas/SslMode' default: prefer title: SSL Mode user: title: User type: string required: - host - user - dbname title: VerticaConfig type: object ValidationError: properties: loc: items: anyOf: - type: string - type: integer title: Location type: array msg: title: Message type: string type: title: Error Type type: string required: - loc - msg - type title: ValidationError type: object TestResultStep: properties: result: anyOf: - {} - type: 'null' title: Result status: $ref: '#/components/schemas/JobStatus' step: $ref: '#/components/schemas/ConfigurationCheckStep' required: - step - status title: TestResultStep type: object CertCheck: enum: - disable - dremio-cloud - customcert title: CertCheck type: string SslMode: description: >- SSL mode for database connections (used by PostgreSQL, Vertica, Redshift, etc.) enum: - prefer - require - verify-ca - verify-full title: SslMode type: string SSLVerification: enum: - full - none - ca title: SSLVerification type: string JobStatus: enum: - needs_confirmation - needs_authentication - waiting - processing - done - failed - cancelled title: JobStatus type: string ConfigurationCheckStep: enum: - connection - temp_schema - schema_download - lineage_download title: ConfigurationCheckStep type: string securitySchemes: ApiKeyAuth: description: Use the 'Authorization' header with the format 'Key ' in: header name: Authorization type: apiKey ````