API reference / @evolu/common / Evolu/Internal / getDbSchema

Function: getDbSchema()

function getDbSchema(deps): (__namedParameters) => Result<Readonly<{
  indexes: readonly Readonly<{
     name: string;
     sql: string;
  }>[];
  tables: readonly Readonly<{
     columns: readonly string & Brand<"Base64Url"> & Brand<"MaxLength256">[];
     name: string & Brand<"Base64Url"> & Brand<"MaxLength256">;
  }>[];
}>, SqliteError>;

Defined in: packages/common/src/Evolu/Db.ts:535

Get the current database schema by reading SQLite metadata.

TODO: Refactor out Evolu stuff and move it to Sqlite.

Parameters

Parameter	Type
`deps`	`SqliteDep`

Returns

(__namedParameters): Result<Readonly<{
  indexes: readonly Readonly<{
     name: string;
     sql: string;
  }>[];
  tables: readonly Readonly<{
     columns: readonly string & Brand<"Base64Url"> & Brand<"MaxLength256">[];
     name: string & Brand<"Base64Url"> & Brand<"MaxLength256">;
  }>[];
}>, SqliteError>;

Parameters

Parameter	Type
`__namedParameters`	{ `allIndexes?`: `boolean`; }
`__namedParameters.allIndexes?`	`boolean`

Returns

Result<Readonly<{ indexes: readonly Readonly<{ name: string; sql: string; }>[]; tables: readonly Readonly<{ columns: readonly string & Brand<"Base64Url"> & Brand<"MaxLength256">[]; name: string & Brand<"Base64Url"> & Brand<"MaxLength256">; }>[]; }>, SqliteError>