OpenMetadata/docs/openmetadata-apis/schemas/entities/location.md

Location

This schema defines the Location entity. A Location can contain the data of a table or group other sublocation together.

$id:https://open-metadata.org/schema/entity/data/location.json

Type: object

This schema does not accept additional properties.

Properties

• id
  • Unique identifier of this location instance.
  • $ref: ../../type/basic.json#/definitions/uuid
• name required
  • Name of a location without the service. For example s3://bucket/path1/path2.
  • $ref: #/definitions/locationName
• displayName
  • Display Name that identifies this table. It could be title or label from the source services.
  • Type: string
• fullyQualifiedName
  • Fully qualified name of a location in the form serviceName.locationName.
  • Type: string
• description
  • Description of a location.
  • Type: string
• version
  • Metadata version of the entity.
  • $ref: ../../type/entityHistory.json#/definitions/entityVersion
• updatedAt
  • Last update time corresponding to the new version of the entity in Unix epoch time milliseconds.
  • $ref: ../../type/basic.json#/definitions/timestamp
• updatedBy
  • User who made the update.
  • Type: string
• href
  • Link to this location resource.
  • $ref: ../../type/basic.json#/definitions/href
• locationType
  • $ref: #/definitions/locationType
• owner
  • Owner of this location.
  • $ref: ../../type/entityReference.json
• followers
  • Followers of this location.
  • $ref: ../../type/entityReference.json#/definitions/entityReferenceList
• tags
  • Tags for this location.
  • Type: array
    • Items
    • $ref: ../../type/tagLabel.json
• service required
  • Link to the database cluster/service where this database is hosted in.
  • $ref: ../../type/entityReference.json
• serviceType
  • Service type where this storage location is hosted in.
  • $ref: ../../type/storage.json#/definitions/storageServiceType
• changeDescription
  • Change that lead to this version of the entity.
  • $ref: ../../type/entityHistory.json#/definitions/changeDescription
• deleted
  • When true indicates the entity has been soft deleted.
  • Type: boolean
  • Default: false

Type definitions in this schema

locationName

• Local name (not fully qualified name) of a location.
• Type: string
• Length: between 1 and 128

locationType

• This schema defines the type used for describing different types of Location.
• Type: string
• The value is restricted to the following:
  1. "Bucket"
  2. "Prefix"
  3. "Database"
  4. "Table"

This document was updated on: Tuesday, January 25, 2022