base_Root_sql.md

@onzag/itemize / Modules / base/Root/sql

Module: base/Root/sql

Basically just contains types and the function that specifies how the whole database for the itemize project should be described

Table of contents

Interfaces

• IElasticIndexDefinitionType
• IElasticSchemaDefinitionType
• ISQLColumnDefinitionType
• ISQLSchemaDefinitionType
• ISQLStreamComposedTableRowValue
• ISQLTableDefinitionType
• ISQLTableIndexType
• ISQLTableRowValue

Type Aliases

• ConsumeStreamsFnType

Functions

• getElasticSchemaForRoot
• getSQLTablesSchemaForRoot

Type Aliases

ConsumeStreamsFnType

Ƭ ConsumeStreamsFnType: (propertyLocationId: string) => Promise<void>

Type declaration

▸ (propertyLocationId): Promise<void>

Parameters

Name	Type
propertyLocationId	string

Returns

Promise<void>

Defined in

base/Root/sql.ts:128

Functions

getElasticSchemaForRoot

▸ getElasticSchemaForRoot(root, serverData, appData): IElasticSchemaDefinitionType

Parameters

Name	Type
root	default
serverData	any
appData	IAppDataType

Returns

IElasticSchemaDefinitionType

Defined in

base/Root/sql.ts:138

---

getSQLTablesSchemaForRoot

▸ getSQLTablesSchemaForRoot(root): ISQLSchemaDefinitionType

Provides the whole schema that is necessary to populate in order for all the items contained within this root to function in the database

Parameters

Name	Type	Description
root	default	The root in question

Returns

ISQLSchemaDefinitionType

a total database schema

Defined in

base/Root/sql.ts:156