json.schema.metadataIngestion.databaseServiceQueryUsagePipeline.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openmetadata-core Show documentation

The newest version!

{
  "$id": "https://open-metadata.org/schema/entity/services/ingestionPipelines/databaseServiceQueryUsagePipeline.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DatabaseServiceQueryUsagePipeline",
  "description": "DatabaseService Query Usage Pipeline Configuration.",
  "definitions": {
    "databaseUsageConfigType": {
      "description": "Database Source Config Usage Pipeline type",
      "type": "string",
      "enum": ["DatabaseUsage"],
      "default": "DatabaseUsage"
    }
  },
  "properties": {
    "type": {
      "description": "Pipeline type",
      "$ref": "#/definitions/databaseUsageConfigType",
      "default": "DatabaseUsage"
    },
    "queryLogDuration": {
      "description": "Configuration to tune how far we want to look back in query logs to process usage data.",
      "type": "integer",
      "default": "1"
    },
    "stageFileLocation": {
      "description": "Temporary file name to store the query logs before processing. Absolute file path required.",
      "type": "string",
      "default": "/tmp/query_log"
    },
    "resultLimit": {
      "description": "Configuration to set the limit for query logs",
      "type": "integer",
      "default": "100"
    },
    "queryLogFilePath": {
      "description": "Configuration to set the file path for query logs",
      "type": "string"
    },
    "schemaFilterPattern": {
      "description": "Regex to only fetch tables or databases that matches the pattern.",
      "$ref": "../type/filterPattern.json#/definitions/filterPattern"
    },
    "tableFilterPattern": {
      "description": "Regex exclude tables or databases that matches the pattern.",
      "$ref": "../type/filterPattern.json#/definitions/filterPattern"
    },
    "databaseFilterPattern": {
      "description": "Regex to only fetch databases that matches the pattern.",
      "$ref": "../type/filterPattern.json#/definitions/filterPattern"
    }
  },
  "additionalProperties": false
}