You will need a cloud project with permissions to use BigQuery and Knowledge Catalog APIs.

export DEMO_CLOUD_PROJECT=<GCP_PROJECT_ID>

Ensure that gcloud is installed and configured.

gcloud auth application-default login
gcloud config set compute/region us-central1
gcloud config set project $DEMO_CLOUD_PROJECT

This demo demonstrates working with metadata for BigQuery resources (dataset and table).

Setup

• Creates a BigQuery dataset (demo_ecommerce) and a table (events) based on BigQuery sample data in your cloud project.
• Creates a catalog.yaml manifest to specify the local catalog snapshot.

bun setup.ts
cat catalog.yaml

Create Metadata Snapshot

• Pull metadata from Knowledge Catalog

../../dist/kcmd pull
ls -R catalog
cat catalog/$DEMO_CLOUD_PROJECT.demo_ecommerce.yaml

Modify Metadata Snapshot

• Either manually edit the file, or use the following command which adds a dummy overview aspect.

bun update.ts catalog/$DEMO_CLOUD_PROJECT.demo_ecommerce.yaml
cat catalog/$DEMO_CLOUD_PROJECT.demo_ecommerce.yaml

Publish Metadata Snapshot

• Push metadata to Knowledge Catalog

../../dist/kcmd push

Cleanup

• Deletes the BigQuery resources created for the demo

bun cleanup.ts

This demo demonstrates working with a Knowledge Base managed in Knowledge Catalog.

Setup

• Creates a Dataplex EntryGroup (demo_kb) and a set of document entries within it.
• Creates a catalog.yaml manifest to specify the local catalog snapshot.

bun setup.ts
cat catalog.yaml

Create Metadata Snapshot

• Pull metadata from Knowledge Catalog

../../dist/kcmd pull
ls -R catalog
cat catalog/index.md

Modify Metadata Snapshot

• Either manually edit the file, or use the following command which creates a placeholder demo update to the content of the index entry using the kcmd (metadata as code) library.

bun update.ts
cat catalog/index.md

Publish Metadata Snapshot

• Push metadata to Knowledge Catalog

../../dist/kcmd push

Cleanup

• Deletes the Dataplex EntryGroup

bun cleanup.ts

This demo demonstrates publishing an Open Knowledge Format wiki bundle (a directory of markdown files with YAML frontmatter) into a Knowledge Catalog EntryGroup via the Documents Layout. The bundle in okf/catalog/ is a GA4 sample with indexes, references, a dataset, and a table, 17 markdown files in total. The Documents Layout maps each .md file to an entry whose name is derived from the file path, with the markdown body stored on the dataplex-types.global.overview aspect.

Setup

• Creates an empty Dataplex EntryGroup (okf_ga4).
• Creates a catalog.yaml manifest pointing at the EntryGroup.
• The catalog/ directory is already populated with the GA4 markdown bundle.

bun setup.ts
cat catalog.yaml
ls -R catalog

Publish Metadata Snapshot

• Push the bundled markdown to Knowledge Catalog. Entry names mirror the file path (e.g. references/metrics/event_count.md → entry references/metrics/event_count). Custom type: values in frontmatter that aren't valid Dataplex type refs fall back to dataplex-types.global.generic.

../../dist/kcmd push

Modify Metadata Snapshot

• Edit any markdown file under catalog/ directly. Both frontmatter fields (title, description, tags) and the markdown body can be changed, then push again.

../../dist/kcmd push

Cleanup

• Deletes the Dataplex EntryGroup

bun cleanup.ts