Class Database

Hierarchy

Database

Index

Constructors

constructor

Properties

parent

Methods

Constructors

constructor

new Database(parent: StevesDBClient, name: string): Database

- Defined in database/database.ts:15
Parameters
- parent: StevesDBClient
- name: string
Returns Database

Properties

Readonly parent

parent: StevesDBClient

Methods

create

create(): Promise<boolean>

- Defined in database/database.ts:86
Create the database

Returns Promise<boolean>

true, if the database was successfuly created

delete

delete(): Promise<boolean>

- Defined in database/database.ts:96
Delete the database

Returns Promise<boolean>

true, if the database was sucessfuly deleted

exists

exists(): Promise<boolean>

- Defined in database/database.ts:72
Check whether does the database exist

Returns Promise<boolean>

true, if the databse does exist

getName

getName(): string

- Defined in database/database.ts:122
Get the database name

Returns string

the database name

getTable

getTable(name: string): Table

- Defined in database/database.ts:55
Get the table by it's name

Parameters
- name: string
  
  table name
Returns Table

the table

getTableIfExists

getTableIfExists(name: string): Promise<Table | undefined>

- Defined in database/database.ts:41
Get the table by it's name if it exists, undefined otherwise

Parameters
- name: string
  
  table name
Returns Promise<Table | undefined>

the table if it exists, undefined otherwise

getTables

getTables(): Promise<Table[]>

- Defined in database/database.ts:26
Get the list of tables in the database

Returns Promise<Table[]>

the list of the tables

rename

rename(newName: string): Promise<boolean>

- Defined in database/database.ts:107
Rename the database

Parameters
- newName: string
  
  the new name of the database
Returns Promise<boolean>

true, if the database was sucessfuly renamed

table

table(name: string): Table

- Defined in database/database.ts:64
Alias for getTable

Parameters
- name: string
  
  table name
Returns Table

the table

Generated using TypeDoc