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

analytics.query.execute

Execute a data query.

  • Type: operation (query)
  • Version: 1.0.0
  • Stability: stable
  • Owners: @example.analytics-dashboard
  • Tags: analytics, query, execute
  • File: packages/examples/analytics-dashboard/src/query/query.operation.ts
    • field.key.label
    analytics.query.execute
    field.version.label
    1.0.0
    field.type.label
    operation (query)
    field.title.label
    analytics.query.execute
    field.description.label

    Execute a data query.

  • Type: operation (query)
  • Version: 1.0.0
  • Stability: stable
  • Owners: @example.analytics-dashboard
  • Tags: analytics, query, execute
  • File: packages/examples/analytics-dashboard/src/query/query.operation.ts
    • field.tags.label
    analytics,query,execute
    field.owners.label
    @example.analytics-dashboard
    field.stability.label
    stable

    Execute a data query.

    Goal

    Fetch data for visualizations.

    Context

    Dashboard rendering.

    Source Definition

    import {
	defineCommand,
	defineQuery,
} from '@lssm-tech/lib.contracts-spec/operations';
import {
	CreateQueryInputModel,
	ExecuteQueryInputModel,
	QueryModel,
	QueryResultModel,
} from './query.schema';

export const ExecuteQueryContract = defineQuery({
	meta: {
		key: 'analytics.query.execute',
		version: '1.0.0',
		stability: 'stable',
		owners: ['@example.analytics-dashboard'],
		tags: ['analytics', 'query', 'execute'],
		description: 'Execute a data query.',
		goal: 'Fetch data for visualizations.',
		context: 'Dashboard rendering.',
	},
	io: { input: ExecuteQueryInputModel, output: QueryResultModel },
	policy: { auth: 'user' },
	acceptance: {
		scenarios: [
			{
				key: 'execute-query-happy-path',
				given: ['Query exists'],
				when: ['User executes query with parameters'],
				then: ['Query results are returned'],
			},
		],
		examples: [
			{
				key: 'execute-with-params',
				input: { queryId: 'query-123', params: { startDate: '2025-01-01' } },
				output: { columns: ['total'], rows: [{ total: 50000 }], rowCount: 1 },
			},
		],
	},
});