OSS-first docs

These docs teach the open system first: contracts, generated surfaces, runtimes, governance, and incremental adoption. Studio shows up as the operating layer on top, not as the source of truth.

AI index

database.dictionary.get

Retrieve a data dictionary entry for a schema field.

  • Type: operation (query)
  • Version: 1.0.0
  • Tags: dictionary
  • File: packages/libs/contracts-spec/src/database/queries/databaseDictionaryGet.query.ts
    • field.key.label
    database.dictionary.get
    field.version.label
    1.0.0
    field.type.label
    operation (query)
    field.title.label
    database.dictionary.get
    field.description.label

    Retrieve a data dictionary entry for a schema field.

  • Type: operation (query)
  • Version: 1.0.0
  • Tags: dictionary
  • File: packages/libs/contracts-spec/src/database/queries/databaseDictionaryGet.query.ts
    • field.tags.label
    dictionary
    field.owners.label
    field.stability.label

    Retrieve a data dictionary entry for a schema field.

    Goal

    Provide semantic context for schema fields and PII handling.

    Context

    Used by agents to interpret data before retrieval or export.

    Source Definition

    import { ScalarTypeEnum, SchemaModel } from '@lssm-tech/lib.schema';
import { docRef } from '../../docs/registry';
import type { DocBlock } from '../../docs/types';
import { defineQuery } from '../../operations';
import {
	DATABASE_DOMAIN,
	DATABASE_OWNERS,
	DATABASE_STABILITY,
	DATABASE_TAGS,
} from '../constants';

export const DatabaseDictionaryGetQuery = defineQuery({
	meta: {
		key: 'database.dictionary.get',
		title: 'Get Data Dictionary Entry',
		version: '1.0.0',
		description: 'Retrieve a data dictionary entry for a schema field.',
		goal: 'Provide semantic context for schema fields and PII handling.',
		context: 'Used by agents to interpret data before retrieval or export.',
		domain: DATABASE_DOMAIN,
		owners: DATABASE_OWNERS,
		tags: [...DATABASE_TAGS, 'dictionary'],
		stability: DATABASE_STABILITY,
		docId: [docRef(DatabaseDictionaryGetDocBlock.id)],
	},
	capability: {
		key: 'database.context',
		version: '1.0.0',
	},
	io: {
		input: DatabaseDictionaryGetInput,
		output: DatabaseDictionaryGetOutput,
	},
	policy: {
		auth: 'admin',
		pii: [],
	},
});