ComponentMetadata¶

Self-describing metadata block stored at the top level of every component YAML file. The type field identifies the component kind (e.g. "pipeline", "table", "view"). tags carries the tag list that was previously stored only in manifest.yaml. apiVersion allows future loaders to handle format evolution gracefully.

Contexts¶

Context	Relationship	Object Path	Package File Path
`Database.metadata`	`Package` -> `Database` -> `ComponentMetadata`	`$.databases[*].metadata`	`{package-root}/databases/{db-name}/`
`Database.Shard.metadata`	`Package` -> `Database` -> `Shard` -> `ComponentMetadata`	`$.databases[].shards[].metadata`	`{package-root}/databases/{db-name}/shards/{shard-name}.yaml`
`Database.Shard.Sequencer.metadata`	`Package` -> `Database` -> `Shard` -> `Sequencer` -> `ComponentMetadata`	`$.databases[].shards[].sequencers.*.metadata`	`{package-root}/databases/{db-name}/shards/{shard-name}.yaml`
`Database.TableList.metadata`	`Package` -> `Database` -> `TableList` -> `ComponentMetadata`	`$.databases[*].tables.metadata`	`{package-root}/databases/{db-name}/`
`Database.TableList.Table.metadata`	`Package` -> `Database` -> `TableList` -> `Table` -> `ComponentMetadata`	`$.databases[].tables.schemas[].metadata`	`{package-root}/databases/{db-name}/`
`DeploymentConfig.metadata`	`Package` -> `DeploymentConfig` -> `ComponentMetadata`	`$.deployment_config.metadata`	`{package-root}/deployment_config/deployment_config.yaml`
`Manifest.Build.metadata`	`Package` -> `Manifest` -> `Build` -> `ComponentMetadata`	`$.manifest.build.metadata`	`{package-root}/manifest.yaml`
`Manifest.Entrypoint.metadata`	`Package` -> `Manifest` -> `Entrypoint` -> `ComponentMetadata`	`$.manifest.entrypoints.*.metadata`	`{package-root}/manifest.yaml`
`Manifest.Metadata.metadata`	`Package` -> `Manifest` -> `Metadata` -> `ComponentMetadata`	`$.manifest.metadata.metadata`	`{package-root}/manifest.yaml`
`Manifest.PatchRef.metadata`	`Package` -> `Manifest` -> `PatchRef` -> `ComponentMetadata`	`$.manifest.patches[*].metadata`	`{package-root}/manifest.yaml`
`Metadata.metadata`	`Package` -> `Metadata` -> `ComponentMetadata`	`$.metadata.metadata`	`{package-root}/manifest.yaml`
`PatchRef.metadata`	`Package` -> `PatchRef` -> `ComponentMetadata`	`$.patches[*].metadata`	`{package-root}/patches/{patch-name}`
`Pipeline.metadata`	`Package` -> `Pipeline` -> `ComponentMetadata`	`$.pipelines[*].metadata`	`{package-root}/pipelines/{pipeline-name}.yaml`
`Router.metadata`	`Package` -> `Router` -> `ComponentMetadata`	`$.router.metadata`	`{package-root}/router/{router-name}.yaml`
`TableList.metadata`	`Package` -> `TableList` -> `ComponentMetadata`	`$.tables.metadata`	`{package-root}/databases/{db-name}/`
`TableList.Table.metadata`	`Package` -> `TableList` -> `Table` -> `ComponentMetadata`	`$.tables.schemas[*].metadata`	`{package-root}/tables/{table-name}.yaml`
`UDFCollection.metadata`	`Package` -> `UDFCollection` -> `ComponentMetadata`	`$.udfs.metadata`	`{package-root}/udfs.yaml`
`UDFCollection.UDA.metadata`	`Package` -> `UDFCollection` -> `UDA` -> `ComponentMetadata`	`$.udfs.udfs[*].metadata`	`{package-root}/udfs.yaml`
`UDFCollection.UDF.metadata`	`Package` -> `UDFCollection` -> `UDF` -> `ComponentMetadata`	`$.udfs.udfs[*].metadata`	`{package-root}/udfs.yaml`
`View.metadata`	`Package` -> `View` -> `ComponentMetadata`	`$.views[*].metadata`	`{package-root}/views/{view-name}.yaml`

Fields¶

Field	Type	Required	Description	Constraints	Default
`type`	`string`	yes	-	-	-
`apiVersion`	`string` \| `null`	no	-	-	`null`
`tags`	`array`<`string`>	no	-	-	-

Links To¶

No linked schemas.

Used In¶

Build via metadata
Database via metadata
DeploymentConfig via metadata
Entrypoint via metadata
Metadata via metadata
PatchRef via metadata
Pipeline via metadata
Router via metadata
Sequencer via metadata
Shard via metadata
Table via metadata
TableList via metadata
UDA via metadata
UDF via metadata
UDFCollection via metadata
View via metadata