json.schema.entity.services.connections.database.bigQueryConnection.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openmetadata-spec Show documentation
There is a newer version: 1.6.0-rc1
{
  "$id": "https://open-metadata.org/schema/entity/services/connections/database/bigQueryConnection.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BigQueryConnection",
  "description": "Google BigQuery Connection Config",
  "type": "object",
  "javaType": "org.openmetadata.schema.services.connections.database.BigQueryConnection",
  "definitions": {
    "bigqueryType": {
      "description": "Service type.",
      "type": "string",
      "enum": [
        "BigQuery"
      ],
      "default": "BigQuery"
    },
    "bigqueryScheme": {
      "description": "SQLAlchemy driver scheme options.",
      "type": "string",
      "enum": [
        "bigquery"
      ],
      "default": "bigquery"
    }
  },
  "properties": {
    "type": {
      "title": "Service Type",
      "description": "Service Type",
      "$ref": "#/definitions/bigqueryType",
      "default": "BigQuery"
    },
    "scheme": {
      "title": "Connection Scheme",
      "description": "SQLAlchemy driver scheme options.",
      "$ref": "#/definitions/bigqueryScheme",
      "default": "bigquery"
    },
    "hostPort": {
      "title": "Host and Port",
      "description": "BigQuery APIs URL.",
      "type": "string",
      "default": "bigquery.googleapis.com"
    },
    "credentials": {
      "title": "GCP Credentials",
      "description": "GCP Credentials",
      "$ref": "../../../../security/credentials/gcpCredentials.json"
    },
    "taxonomyProjectID": {
      "title": "Taxonomy Project IDs",
      "description": "Project IDs used to fetch policy tags",
      "type": "array",
      "items": {
        "type": "string"
      },
      "default": null
    },
    "taxonomyLocation": {
      "title": "Taxonomy Location",
      "description": "Taxonomy location used to fetch policy tags",
      "type": "string",
      "default": "us"
    },
    "usageLocation": {
      "title": "Usage Location",
      "description": "Location used to query INFORMATION_SCHEMA.JOBS_BY_PROJECT to fetch usage data. You can pass multi-regions, such as `us` or `eu`, or you specific region. Australia and Asia multi-regions are not yet in GA.",
      "type": "string",
      "default": "us"
    },
    "connectionOptions": {
      "title": "Connection Options",
      "$ref": "../connectionBasicType.json#/definitions/connectionOptions"
    },
    "connectionArguments": {
      "title": "Connection Arguments",
      "$ref": "../connectionBasicType.json#/definitions/connectionArguments"
    },
    "supportsMetadataExtraction": {
      "title": "Supports Metadata Extraction",
      "$ref": "../connectionBasicType.json#/definitions/supportsMetadataExtraction"
    },
    "supportsUsageExtraction": {
      "$ref": "../connectionBasicType.json#/definitions/supportsUsageExtraction"
    },
    "supportsLineageExtraction": {
      "$ref": "../connectionBasicType.json#/definitions/supportsLineageExtraction"
    },
    "supportsDBTExtraction": {
      "$ref": "../connectionBasicType.json#/definitions/supportsDBTExtraction"
    },
    "supportsProfiler": {
      "title": "Supports Profiler",
      "$ref": "../connectionBasicType.json#/definitions/supportsProfiler"
    },
    "supportsDatabase": {
      "title": "Supports Database",
      "$ref": "../connectionBasicType.json#/definitions/supportsDatabase"
    },
    "supportsQueryComment": {
      "title": "Supports Query Comment",
      "$ref": "../connectionBasicType.json#/definitions/supportsQueryComment"
    },
    "sampleDataStorageConfig": {
      "title": "Storage Config for Sample Data",
      "$ref": "../connectionBasicType.json#/definitions/sampleDataStorageConfig"
    }
  },
  "additionalProperties": false,
  "required": [
    "credentials"
  ]
}