json.schema.entity.services.connections.database.pinotDBConnection.json Maven / Gradle / Ivy
{
"$id": "https://open-metadata.org/schema/entity/services/connections/database/pinotDBConnection.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "PinotDBConnection",
"description": "PinotDB Database Connection Config",
"type": "object",
"javaType": "org.openmetadata.schema.services.connections.database.PinotDBConnection",
"definitions": {
"pinotDBType": {
"description": "Service type.",
"type": "string",
"enum": ["PinotDB"],
"default": "PinotDB"
},
"pinotDBScheme": {
"description": "SQLAlchemy driver scheme options.",
"type": "string",
"enum": ["pinot", "pinot+http", "pinot+https"],
"default": "pinot"
}
},
"properties": {
"type": {
"title": "Service Type",
"description": "Service Type",
"$ref": "#/definitions/pinotDBType",
"default": "PinotDB"
},
"scheme": {
"title": "Connection Scheme",
"description": "SQLAlchemy driver scheme options.",
"$ref": "#/definitions/pinotDBScheme",
"default": "pinot"
},
"username": {
"title": "Username",
"description": "username to connect to the PinotDB. This user should have privileges to read all the metadata in PinotDB.",
"type": "string"
},
"password": {
"title": "Password",
"description": "password to connect to the PinotDB.",
"type": "string",
"format": "password"
},
"hostPort": {
"title": "Pinot Broker Host and Port",
"description": "Host and port of the PinotDB Broker service.",
"type": "string"
},
"pinotControllerHost": {
"title": "Pinot Controller Host and Port",
"description": "Pinot Controller Host and Port of the data source.",
"type": "string"
},
"database": {
"title": "Database",
"description": "Database of the data source. This is optional parameter, if you would like to restrict the metadata reading to a single database. When left blank, OpenMetadata Ingestion attempts to scan all the databases.",
"type": "string"
},
"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"
},
"supportsDBTExtraction": {
"$ref": "../connectionBasicType.json#/definitions/supportsDBTExtraction"
},
"supportsProfiler": {
"title": "Supports Profiler",
"$ref": "../connectionBasicType.json#/definitions/supportsProfiler"
},
"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": ["hostPort", "pinotControllerHost"]
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy