Class RelationDatabase

Hierarchy

RelationDatabase

Implements

IRelationalDatabase

Index

Constructors

constructor

Methods

Constructors

constructor

new RelationDatabase(): RelationDatabase

- Defined in relational/database.ts:24
Represents a relational database.

Returns RelationDatabase

Methods

addForeignkey

addForeignkey(name: string, foreignKey: string, foreignName: string): void

Implementation of IRelationalDatabase.addForeignkey
- Defined in relational/database.ts:62
Defines a foreign relation between two tables.

Parameters
- name: string
- foreignKey: string
- foreignName: string
Returns void

addTable

addTable(options: IRelationalTableOptions): IRelationalTable

Implementation of IRelationalDatabase.addTable
- Defined in relational/database.ts:48
Defines a table in the database.

function

addTable

Parameters
- options: IRelationalTableOptions
Returns IRelationalTable

destroy

destroy(): void

Implementation of IRelationalDatabase.destroy
- Defined in relational/database.ts:81
Destroys database

Returns void

getReference

getReference(): IRelationalDatabase

Implementation of IRelationalDatabase.getReference
- Defined in relational/database.ts:38
Gets a reference of the file system database

Returns IRelationalDatabase

getTable

getTable(name: string): IRelationalTable

Implementation of IRelationalDatabase.getTable
- Defined in relational/database.ts:55
Retrieves a table by name.

Parameters
- name: string
Returns IRelationalTable

Generated using TypeDoc