ContractSpec docs

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.

platform.database

Describe schemas, list migrations, query data dictionaries, and execute read-only queries

  • Type: feature
  • Version: 1.0.0
  • File: packages/libs/contracts-spec/src/database/database.feature.ts
  • field.key.label
    platform.database
    field.version.label
    1.0.0
    field.type.label
    feature
    field.title.label
    platform.database
    field.description.label

    Describe schemas, list migrations, query data dictionaries, and execute read-only queries

  • Type: feature
  • Version: 1.0.0
  • File: packages/libs/contracts-spec/src/database/database.feature.ts
  • field.tags.label
    field.owners.label
    field.stability.label

    Describe schemas, list migrations, query data dictionaries, and execute read-only queries

    Operations (4)

    `database.schema.describe` (v1.0.0)

    `database.migrations.list` (v1.0.0)

    `database.dictionary.get` (v1.0.0)

    `database.query.readonly` (v1.0.0)

    Source Definition

    import { defineFeature } from '../features';
    import {
    	DATABASE_DOMAIN,
    	DATABASE_OWNERS,
    	DATABASE_STABILITY,
    	DATABASE_TAGS,
    } from './constants';
    
    export const DatabaseFeature = defineFeature({
    	meta: {
    		key: 'platform.database',
    		version: '1.0.0',
    		title: 'Database Context',
    		description:
    			'Describe schemas, list migrations, query data dictionaries, and execute read-only queries',
    		domain: DATABASE_DOMAIN,
    		owners: DATABASE_OWNERS,
    		tags: [...DATABASE_TAGS],
    		stability: DATABASE_STABILITY,
    	},
    
    	operations: [
    		{ key: 'database.schema.describe', version: '1.0.0' },
    		{ key: 'database.migrations.list', version: '1.0.0' },
    		{ key: 'database.dictionary.get', version: '1.0.0' },
    		{ key: 'database.query.readonly', version: '1.0.0' },
    	],
    
    	capabilities: {
    		provides: [{ key: 'database.context', version: '1.0.0' }],
    	},
    
    	dataViews: [{ key: 'database.schema.index', version: '1.0.0' }],
    });