drizzle-orm Architecture Docs
Home / Function/ singlestoreTableWithSchema() — drizzle-orm Function Reference

singlestoreTableWithSchema() — drizzle-orm Function Reference

Architecture documentation for the singlestoreTableWithSchema() function in table.ts from the drizzle-orm codebase.

Function typescript DrizzleORM RelationalQuery calls 2 called by 2

Entity Profile

Dependency Diagram

graph TD
  c2bf33cf_2c60_b5d0_956c_7bd00c4f94ba["singlestoreTableWithSchema()"]
  3c5f95cc_22b6_3d0d_d9be_3e274450e9e7["table.ts"]
  c2bf33cf_2c60_b5d0_956c_7bd00c4f94ba -->|defined in| 3c5f95cc_22b6_3d0d_d9be_3e274450e9e7
  ca403d8b_456e_229e_aeb7_788857edacf0["singlestoreTable()"]
  ca403d8b_456e_229e_aeb7_788857edacf0 -->|calls| c2bf33cf_2c60_b5d0_956c_7bd00c4f94ba
  1b9e89dc_fdde_3a2a_617d_6f1654086e92["singlestoreTableCreator()"]
  1b9e89dc_fdde_3a2a_617d_6f1654086e92 -->|calls| c2bf33cf_2c60_b5d0_956c_7bd00c4f94ba
  adc207f1_b49e_bb28_3384_60680d359af5["getSingleStoreColumnBuilders()"]
  c2bf33cf_2c60_b5d0_956c_7bd00c4f94ba -->|calls| adc207f1_b49e_bb28_3384_60680d359af5
  d4db3f8a_9eef_2b17_0789_317ef2c57f6e["build()"]
  c2bf33cf_2c60_b5d0_956c_7bd00c4f94ba -->|calls| d4db3f8a_9eef_2b17_0789_317ef2c57f6e
  style c2bf33cf_2c60_b5d0_956c_7bd00c4f94ba fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/singlestore-core/table.ts lines 49–103

export function singlestoreTableWithSchema<
	TTableName extends string,
	TSchemaName extends string | undefined,
	TColumnsMap extends Record<string, SingleStoreColumnBuilderBase>,
>(
	name: TTableName,
	columns: TColumnsMap | ((columnTypes: SingleStoreColumnBuilders) => TColumnsMap),
	extraConfig:
		| ((
			self: BuildColumns<TTableName, TColumnsMap, 'singlestore'>,
		) => SingleStoreTableExtraConfig | SingleStoreTableExtraConfigValue[])
		| undefined,
	schema: TSchemaName,
	baseName = name,
): SingleStoreTableWithColumns<{
	name: TTableName;
	schema: TSchemaName;
	columns: BuildColumns<TTableName, TColumnsMap, 'singlestore'>;
	dialect: 'singlestore';
}> {
	const rawTable = new SingleStoreTable<{
		name: TTableName;
		schema: TSchemaName;
		columns: BuildColumns<TTableName, TColumnsMap, 'singlestore'>;
		dialect: 'singlestore';
	}>(name, schema, baseName);

	const parsedColumns: TColumnsMap = typeof columns === 'function' ? columns(getSingleStoreColumnBuilders()) : columns;

	const builtColumns = Object.fromEntries(
		Object.entries(parsedColumns).map(([name, colBuilderBase]) => {
			const colBuilder = colBuilderBase as SingleStoreColumnBuilder;
			colBuilder.setName(name);
			const column = colBuilder.build(rawTable);
			return [name, column];
		}),
	) as unknown as BuildColumns<TTableName, TColumnsMap, 'singlestore'>;

	const table = Object.assign(rawTable, builtColumns);

	table[Table.Symbol.Columns] = builtColumns;
	table[Table.Symbol.ExtraConfigColumns] = builtColumns as unknown as BuildExtraConfigColumns<
		TTableName,
		TColumnsMap,
		'singlestore'
	>;

	if (extraConfig) {
		table[SingleStoreTable.Symbol.ExtraConfigBuilder] = extraConfig as unknown as (
			self: Record<string, SingleStoreColumn>,
		) => SingleStoreTableExtraConfig;
	}

	return table;
}

Domain

Subdomains

Defined In

Calls

Called By

Source

Frequently Asked Questions

What does singlestoreTableWithSchema() do?
singlestoreTableWithSchema() is a function in the drizzle-orm codebase, defined in drizzle-orm/src/singlestore-core/table.ts.
Where is singlestoreTableWithSchema() defined?
singlestoreTableWithSchema() is defined in drizzle-orm/src/singlestore-core/table.ts at line 49.
What does singlestoreTableWithSchema() call?
singlestoreTableWithSchema() calls 2 function(s): build, getSingleStoreColumnBuilders.
What calls singlestoreTableWithSchema()?
singlestoreTableWithSchema() is called by 2 function(s): singlestoreTable, singlestoreTableCreator.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free