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.

database.schema.describe

Describe database schemas and models with PII indicators.

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

    Describe database schemas and models with PII indicators.

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

    Describe database schemas and models with PII indicators.

    Goal

    Provide deterministic schema context for agents and operators.

    Context

    Used before live data access to ensure schema awareness and policy checks.

    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 DatabaseSchemaDescribeQuery = defineQuery({
    	meta: {
    		key: 'database.schema.describe',
    		title: 'Describe Database Schema',
    		version: '1.0.0',
    		description: 'Describe database schemas and models with PII indicators.',
    		goal: 'Provide deterministic schema context for agents and operators.',
    		context:
    			'Used before live data access to ensure schema awareness and policy checks.',
    		domain: DATABASE_DOMAIN,
    		owners: DATABASE_OWNERS,
    		tags: [...DATABASE_TAGS, 'describe'],
    		stability: DATABASE_STABILITY,
    		docId: [docRef(DatabaseSchemaDescribeDocBlock.id)],
    	},
    	capability: {
    		key: 'database.context',
    		version: '1.0.0',
    	},
    	io: {
    		input: DatabaseSchemaDescribeInput,
    		output: DatabaseSchemaDescribeOutput,
    	},
    	policy: {
    		auth: 'admin',
    		pii: [],
    	},
    });