table

Summary

Creates a table object with symbol-backed metadata and direct column references.

Signature

function table<
  name extends string,
  columns extends TableColumnsDefinition,
  primaryKey extends
    | string
    | readonly ColumnNameFromColumns<columns>[]
    | undefined,
>(
  options: CreateTableOptions<name, columns, primaryKey>,
): Table<name, columns, NormalizePrimaryKey<columns, primaryKey>>;

Example

import { column as c, table } from "remix/data-table";

let users = table({
  name: "users",
  columns: {
    id: c.integer(),
    email: c.varchar(255),
  },
  primaryKey: "id",
});

Parameters

options

Table declaration options.

Returns

A frozen table object.