DatabaseRoute | @sheetbase/database

Hierarchy

DatabaseRoute

Index

Constructors

constructor

Properties

Methods

Object literals

errors

Constructors

constructor

new DatabaseRoute(databaseService: DatabaseService, securityService: SecurityService): DatabaseRoute

- Defined in lib/routes/database.route.ts:14
Parameters
- databaseService: DatabaseService
- securityService: SecurityService
Returns DatabaseRoute

Properties

disabled

disabled: string[] = ['get', 'post', 'put', 'patch', 'delete']

endpoint

endpoint: string = "/database"

Methods

delete

delete(req: { body: { id?: undefined | string; key?: undefined | string; path: string; sheet?: undefined | string; table?: undefined | string } }): void

- Defined in lib/routes/database.route.ts:196
Delete an item from the database (proxy to: post /database)

Parameters
- req: { body: { id?: undefined | string; key?: undefined | string; path: string; sheet?: undefined | string; table?: undefined | string } }
  - body: { id?: undefined | string; key?: undefined | string; path: string; sheet?: undefined | string; table?: undefined | string }
    - Optional id?: undefined | string
    - Optional key?: undefined | string
    - path: string
    - Optional sheet?: undefined | string
    - Optional table?: undefined | string
Returns void

get

get(req: { query: { id?: undefined | string; key?: undefined | string; limit?: undefined | number; offset?: undefined | number; order?: undefined | string; orderBy?: undefined | string; path?: undefined | string; query?: undefined | string; segment?: undefined | string; sheet?: undefined | string; table?: undefined | string; type?: "list" | "object" } }): Record<string, unknown> | unknown[]

- Defined in lib/routes/database.route.ts:36
Get data from the database

Parameters
- req: { query: { id?: undefined | string; key?: undefined | string; limit?: undefined | number; offset?: undefined | number; order?: undefined | string; orderBy?: undefined | string; path?: undefined | string; query?: undefined | string; segment?: undefined | string; sheet?: undefined | string; table?: undefined | string; type?: "list" | "object" } }
  - query: { id?: undefined | string; key?: undefined | string; limit?: undefined | number; offset?: undefined | number; order?: undefined | string; orderBy?: undefined | string; path?: undefined | string; query?: undefined | string; segment?: undefined | string; sheet?: undefined | string; table?: undefined | string; type?: "list" | "object" }
    - Optional id?: undefined | string
    - Optional key?: undefined | string
    - Optional limit?: undefined | number
    - Optional offset?: undefined | number
    - Optional order?: undefined | string
    - Optional orderBy?: undefined | string
    - Optional path?: undefined | string
    - Optional query?: undefined | string
    - Optional segment?: undefined | string
    - Optional sheet?: undefined | string
    - Optional table?: undefined | string
    - Optional type?: "list" | "object"
Returns Record<string, unknown> | unknown[]

patch

patch(req: { body: { data?: unknown; id?: undefined | string; key?: undefined | string; path: string; sheet?: undefined | string; table?: undefined | string } }): void

- Defined in lib/routes/database.route.ts:180
Update an item from the database (proxy to: post /database)

Parameters
- req: { body: { data?: unknown; id?: undefined | string; key?: undefined | string; path: string; sheet?: undefined | string; table?: undefined | string } }
  - body: { data?: unknown; id?: undefined | string; key?: undefined | string; path: string; sheet?: undefined | string; table?: undefined | string }
    - Optional data?: unknown
    - Optional id?: undefined | string
    - Optional key?: undefined | string
    - path: string
    - Optional sheet?: undefined | string
    - Optional table?: undefined | string
Returns void

post

post(req: { body: { clean?: undefined | false | true; data?: unknown; id?: undefined | string; increasing?: Record<string, number>; key?: undefined | string; path: string; sheet?: undefined | string; table?: undefined | string } }): void

- Defined in lib/routes/database.route.ts:118
Add/update/delete data from database

Parameters
- req: { body: { clean?: undefined | false | true; data?: unknown; id?: undefined | string; increasing?: Record<string, number>; key?: undefined | string; path: string; sheet?: undefined | string; table?: undefined | string } }
  - body: { clean?: undefined | false | true; data?: unknown; id?: undefined | string; increasing?: Record<string, number>; key?: undefined | string; path: string; sheet?: undefined | string; table?: undefined | string }
    - Optional clean?: undefined | false | true
    - Optional data?: unknown
    - Optional id?: undefined | string
    - Optional increasing?: Record<string, number>
    - Optional key?: undefined | string
    - path: string
    - Optional sheet?: undefined | string
    - Optional table?: undefined | string
Returns void

put

put(req: { body: { data?: unknown; id?: undefined | string; key?: undefined | string; path: string; sheet?: undefined | string; table?: undefined | string } }): void

- Defined in lib/routes/database.route.ts:163
Add a new item do the database (proxy to: post /database)

Parameters
- req: { body: { data?: unknown; id?: undefined | string; key?: undefined | string; path: string; sheet?: undefined | string; table?: undefined | string } }
  - body: { data?: unknown; id?: undefined | string; key?: undefined | string; path: string; sheet?: undefined | string; table?: undefined | string }
    - Optional data?: unknown
    - Optional id?: undefined | string
    - Optional key?: undefined | string
    - path: string
    - Optional sheet?: undefined | string
    - Optional table?: undefined | string
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

Parameters

databaseService: DatabaseService

securityService: SecurityService

Returns DatabaseRoute

Properties

disabled

endpoint

Methods

delete

Parameters

req: { body: { id?: undefined | string; key?: undefined | string; path: string; sheet?: undefined | string; table?: undefined | string } }

body: { id?: undefined | string; key?: undefined | string; path: string; sheet?: undefined | string; table?: undefined | string }

Optional id?: undefined | string

Optional key?: undefined | string

path: string

Optional sheet?: undefined | string

Optional table?: undefined | string

Returns void

get

Parameters

Optional id?: undefined | string

Optional key?: undefined | string

Optional limit?: undefined | number

Optional offset?: undefined | number

Optional order?: undefined | string

Optional orderBy?: undefined | string

Optional path?: undefined | string

Optional query?: undefined | string

Optional segment?: undefined | string

Optional sheet?: undefined | string

Optional table?: undefined | string

Optional type?: "list" | "object"

Returns Record<string, unknown> | unknown[]

patch

Parameters

req: { body: { data?: unknown; id?: undefined | string; key?: undefined | string; path: string; sheet?: undefined | string; table?: undefined | string } }

body: { data?: unknown; id?: undefined | string; key?: undefined | string; path: string; sheet?: undefined | string; table?: undefined | string }

Optional data?: unknown

Optional id?: undefined | string

Optional key?: undefined | string

path: string

Optional sheet?: undefined | string

Optional table?: undefined | string

Returns void

post

Parameters

req: { body: { clean?: undefined | false | true; data?: unknown; id?: undefined | string; increasing?: Record<string, number>; key?: undefined | string; path: string; sheet?: undefined | string; table?: undefined | string } }

body: { clean?: undefined | false | true; data?: unknown; id?: undefined | string; increasing?: Record<string, number>; key?: undefined | string; path: string; sheet?: undefined | string; table?: undefined | string }

Optional clean?: undefined | false | true

Optional data?: unknown

Optional id?: undefined | string

Optional increasing?: Record<string, number>

Optional key?: undefined | string

path: string

Optional sheet?: undefined | string

Optional table?: undefined | string

Returns void

put

Parameters

req: { body: { data?: unknown; id?: undefined | string; key?: undefined | string; path: string; sheet?: undefined | string; table?: undefined | string } }

body: { data?: unknown; id?: undefined | string; key?: undefined | string; path: string; sheet?: undefined | string; table?: undefined | string }

Optional data?: unknown

Optional id?: undefined | string

Optional key?: undefined | string

path: string

Optional sheet?: undefined | string

Optional table?: undefined | string

Returns void

Object literals

errors

database/no-input