mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-10-10 16:25:37 +00:00
54 lines
4.6 KiB
Markdown
54 lines
4.6 KiB
Markdown
|
---
|
||
|
|
title: databaseSchema
|
||
|
|
slug: /main-concepts/metadata-standard/schemas/entity/data/databaseschema
|
||
|
|
---
|
||
|
|
|
||
|
|
# Database Schema
|
||
|
|
|
||
|
|
*This schema defines the Database Schema entity. A `Database Schema` is collection of tables, views, stored procedures, and other database objects.*
|
||
|
|
|
||
|
|
## Properties
|
||
|
|
|
||
|
|
- **`id`**: Unique identifier that identifies this schema instance. Refer to *../../type/basic.json#/definitions/uuid*.
|
||
|
|
- **`name`**: Name that identifies the schema. Refer to *../../type/basic.json#/definitions/entityName*.
|
||
|
|
- **`fullyQualifiedName`**: Name that uniquely identifies a schema in the format 'ServiceName.DatabaseName.SchemaName'. Refer to *../../type/basic.json#/definitions/fullyQualifiedEntityName*.
|
||
|
|
- **`displayName`** *(string)*: Display Name that identifies this schema.
|
||
|
|
- **`description`**: Description of the schema instance. Refer to *../../type/basic.json#/definitions/markdown*.
|
||
|
|
- **`dataProducts`**: List of data products this entity is part of. Refer to *../../type/entityReferenceList.json*.
|
||
|
|
- **`version`**: Metadata version of the entity. Refer to *../../type/entityHistory.json#/definitions/entityVersion*.
|
||
|
|
- **`updatedAt`**: Last update time corresponding to the new version of the entity in Unix epoch time milliseconds. Refer to *../../type/basic.json#/definitions/timestamp*.
|
||
|
|
- **`updatedBy`** *(string)*: User who made the update.
|
||
|
|
- **`href`**: Link to the resource corresponding to this entity. Refer to *../../type/basic.json#/definitions/href*.
|
||
|
|
- **`owners`**: Owner of this schema. Refer to *../../type/entityReferenceList.json*.
|
||
|
|
- **`service`**: Link to the database cluster/service where this schema is hosted in. Refer to *../../type/entityReference.json*.
|
||
|
|
- **`serviceType`**: Service type where this schema is hosted in. Refer to *../services/databaseService.json#/definitions/databaseServiceType*.
|
||
|
|
- **`database`**: Reference to Database that contains this table. Refer to *../../type/entityReference.json*.
|
||
|
|
- **`tables`**: References to tables in the schema. Refer to *../../type/entityReferenceList.json*.
|
||
|
|
- **`usageSummary`**: Latest usage information for this database. Refer to *../../type/usageDetails.json*. Default: `None`.
|
||
|
|
- **`tags`** *(array)*: Tags for this Database Schema Service. Default: `[]`.
|
||
|
|
- **Items**: Refer to *../../type/tagLabel.json*.
|
||
|
|
- **`changeDescription`**: Change that lead to this version of the entity. Refer to *../../type/entityHistory.json#/definitions/changeDescription*.
|
||
|
|
- **`incrementalChangeDescription`**: Change that lead to this version of the entity. Refer to *../../type/entityHistory.json#/definitions/changeDescription*.
|
||
|
|
- **`deleted`** *(boolean)*: When `true` indicates the entity has been soft deleted. Default: `False`.
|
||
|
|
- **`retentionPeriod`**: Retention period of the data in the database schema. Period is expressed as duration in ISO 8601 format in UTC. Example - `P23DT23H`. When not set, the retention period is inherited from the parent database, if it exists. Refer to *../../type/basic.json#/definitions/duration*.
|
||
|
|
- **`extension`**: Entity extension data with custom attributes added to the entity. Refer to *../../type/basic.json#/definitions/entityExtension*.
|
||
|
|
- **`sourceUrl`**: Source URL of database schema. Refer to *../../type/basic.json#/definitions/sourceUrl*.
|
||
|
|
- **`domains`**: Domains the Database Schema belongs to. When not set, the Schema inherits the domain from the database it belongs to. Refer to *../../type/entityReferenceList.json*.
|
||
|
|
- **`votes`**: Votes on the entity. Refer to *../../type/votes.json*.
|
||
|
|
- **`lifeCycle`**: Life Cycle properties of the entity. Refer to *../../type/lifeCycle.json*.
|
||
|
|
- **`followers`**: Followers of this entity. Refer to *../../type/entityReferenceList.json*.
|
||
|
|
- **`certification`**: Refer to *../../type/assetCertification.json*.
|
||
|
|
- **`sourceHash`** *(string)*: Source hash of the entity.
|
||
|
|
- **`databaseSchemaProfilerConfig`** *(object)*: This schema defines the type for Schema profile config.
|
||
|
|
- **`profileSample`** *(number)*: Percentage of data or no. of rows we want to execute the profiler and tests on. Default: `None`.
|
||
|
|
- **`profileSampleType`**: Refer to *./table.json#/definitions/profileSampleType*.
|
||
|
|
- **`sampleDataCount`** *(integer)*: Number of row of sample data to be generated. Default: `50`.
|
||
|
|
- **`samplingMethodType`**: Refer to *./table.json#/definitions/samplingMethodType*.
|
||
|
|
- **`sampleDataStorageConfig`**: Refer to *../services/connections/connectionBasicType.json#/definitions/sampleDataStorageConfig*.
|
||
|
|
- **`randomizedSample`** *(boolean)*: Whether to randomize the sample data or not. Default: `True`.
|
||
|
|
## Definitions
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
Documentation file automatically generated at 2025-08-12 05:39:47.683420+00:00.
|