Class HarpeeLogger

A class for handling logs for your harperDB instance.

Hierarchy

HarpeeHttp
Hierarchy
- HarpeeLogger

Index

Constructors

constructor

new HarpeeLogger(): HarpeeLogger
Returns HarpeeLogger
Overrides HarpeeHttp.constructor
- Defined in core/harpee-logger.ts:29

Properties

`Static` _schemaConfig

_schemaConfig: IHarpeeSchemaConfig

Methods

deleteRecordsBefore

deleteRecordsBefore<T>(options: IHarperDBDeleteRecordsOptions): Promise<IHarpeeResponse<T>>
Delete data before the specified timestamp on the specified database table exclusively on the node where it is executed. Any clustered nodes with replicated data will retain that data.
Type Parameters
Type Parameters
- T = IHarperDBMessageResponse
Parameters
- options: IHarperDBDeleteRecordsOptions
Returns Promise<IHarpeeResponse<T>>
- Defined in core/harpee-logger.ts:307
deleteRecordsBefore<T>(options: IHarperDBDeleteRecordsOptions, callback: HarpeeResponseCallback<T>): Promise<void>
Type Parameters
Type Parameters
- T = IHarperDBMessageResponse
Parameters
- options: IHarperDBDeleteRecordsOptions
- callback: HarpeeResponseCallback<T>
Returns Promise<void>
- Defined in core/harpee-logger.ts:310

deleteTransactionLogsBefore

deleteTransactionLogsBefore<T>(options: IHarperDBDeleteTransLogOptions): Promise<IHarpeeResponse<T>>
Deletes transaction log data for the specified database table that is older than the specified timestamp.
Type Parameters
Type Parameters
- T = unknown
Parameters
- options: IHarperDBDeleteTransLogOptions
Returns Promise<IHarpeeResponse<T>>
- Defined in core/harpee-logger.ts:348
deleteTransactionLogsBefore<T>(options: IHarperDBDeleteTransLogOptions, callback: HarpeeResponseCallback<T>): Promise<void>
Type Parameters
Type Parameters
- T = unknown
Parameters
- options: IHarperDBDeleteTransLogOptions
- callback: HarpeeResponseCallback<T>
Returns Promise<void>
- Defined in core/harpee-logger.ts:352

getJob

getJob<T>(options: { id: string }): Promise<IHarpeeResponse<T>>
Returns job status, metrics and messages for the specified job ID.
Type Parameters
Type Parameters
- T = object[]
Parameters
- options: { id: string }
  - id: string
    
    the id of the job you wish to view
Returns Promise<IHarpeeResponse<T>>
- Defined in core/harpee-logger.ts:93
getJob<T>(options: { id: string }, callback: HarpeeResponseCallback<T>): Promise<void>
Type Parameters
Type Parameters
- T = object[]
Parameters
- options: { id: string }
  - id: string
    
    the id of the job you wish to view
- callback: HarpeeResponseCallback<T>
Returns Promise<void>
- Defined in core/harpee-logger.ts:98

readLog

readLog<T>(options: IHarpeeReadLogOptions): Promise<IHarpeeResponse<T>>
Returns log outputs from the primary HarperDB log based on the provided search criteria. Read more about HarperDB logging here: https://harperdb.io/docs/reference/logging/.
Type Parameters
Type Parameters
- T = object
Parameters
- options: IHarpeeReadLogOptions
Returns Promise<IHarpeeResponse<T>>
- Defined in core/harpee-logger.ts:36
readLog<T>(options: IHarpeeReadLogOptions, callback: HarpeeResponseCallback<T>): Promise<void>
Type Parameters
Type Parameters
- T = object
Parameters
- options: IHarpeeReadLogOptions
- callback: HarpeeResponseCallback<T>
Returns Promise<void>
- Defined in core/harpee-logger.ts:39

readTransactionLog

readTransactionLog<T>(options: IHarpeeUtilOptions): Promise<IHarpeeResponse<T>>
Returns all transactions logged for the specified database table. Read more about HarperDB transaction logs here: https://harperdb.io/docs/reference/transaction-log/.
Type Parameters
Type Parameters
- T = object[]
Parameters
- options: IHarpeeUtilOptions
Returns Promise<IHarpeeResponse<T>>
- Defined in core/harpee-logger.ts:142
readTransactionLog<T>(options: IHarpeeUtilOptions, callback: HarpeeResponseCallback<T>): Promise<void>
Type Parameters
Type Parameters
- T = object[]
Parameters
- options: IHarpeeUtilOptions
- callback: HarpeeResponseCallback<T>
Returns Promise<void>
- Defined in core/harpee-logger.ts:145

readTransactionLogByHashValue

readTransactionLogByHashValue<T>(options: IHarperDBReadTransLogByHashOptions): Promise<IHarpeeResponse<T>>
Returns the transactions logged for the specified database table which were committed to the specified hash value(s). Read more about HarperDB transaction logs here: https://harperdb.io/docs/reference/transaction-log/.
Type Parameters
Type Parameters
- T = object[]
Parameters
- options: IHarperDBReadTransLogByHashOptions
Returns Promise<IHarpeeResponse<T>>
- Defined in core/harpee-logger.ts:264
readTransactionLogByHashValue<T>(options: IHarperDBReadTransLogByHashOptions, callback: HarpeeResponseCallback<T>): Promise<void>
Type Parameters
Type Parameters
- T = object[]
Parameters
- options: IHarperDBReadTransLogByHashOptions
- callback: HarpeeResponseCallback<T>
Returns Promise<void>
- Defined in core/harpee-logger.ts:267

readTransactionLogByTimestamp

readTransactionLogByTimestamp<T>(options: IHarperDBReadTransLogByTimestampOptions): Promise<IHarpeeResponse<T>>
Returns the transactions logged for the specified database table between the specified time window. Read more about HarperDB transaction logs here: https://harperdb.io/docs/reference/transaction-log/.
Type Parameters
Type Parameters
- T = object[]
Parameters
- options: IHarperDBReadTransLogByTimestampOptions
Returns Promise<IHarpeeResponse<T>>
- Defined in core/harpee-logger.ts:178
readTransactionLogByTimestamp<T>(options: IHarperDBReadTransLogByTimestampOptions, callback: HarpeeResponseCallback<T>): Promise<void>
Type Parameters
Type Parameters
- T = object[]
Parameters
- options: IHarperDBReadTransLogByTimestampOptions
- callback: HarpeeResponseCallback<T>
Returns Promise<void>
- Defined in core/harpee-logger.ts:181

readTransactionLogByUsername

readTransactionLogByUsername<T>(options: IHarperDBReadTransLogByUsernameOptions): Promise<IHarpeeResponse<T>>
Returns the transactions logged for the specified database table which were committed by the specified user. Read more about HarperDB transaction logs here: https://harperdb.io/docs/reference/transaction-log/.
Type Parameters
Type Parameters
- T = object[]
Parameters
- options: IHarperDBReadTransLogByUsernameOptions
Returns Promise<IHarpeeResponse<T>>
- Defined in core/harpee-logger.ts:221
readTransactionLogByUsername<T>(options: IHarperDBReadTransLogByUsernameOptions, callback: HarpeeResponseCallback<T>): Promise<void>
Type Parameters
Type Parameters
- T = object[]
Parameters
- options: IHarperDBReadTransLogByUsernameOptions
- callback: HarpeeResponseCallback<T>
Returns Promise<void>
- Defined in core/harpee-logger.ts:224

searchJobsByStartDate

searchJobsByStartDate<T>(options: IHarperDBSearchJobOptions): Promise<IHarpeeResponse<T>>
Returns a list of job statuses, metrics, and messages for all jobs executed within the specified time window.
Type Parameters
Type Parameters
- T = object[]
Parameters
- options: IHarperDBSearchJobOptions
Returns Promise<IHarpeeResponse<T>>
- Defined in core/harpee-logger.ts:391
searchJobsByStartDate<T>(options: IHarperDBSearchJobOptions, callback: HarpeeResponseCallback<T>): Promise<void>
Type Parameters
Type Parameters
- T = object[]
Parameters
- options: IHarperDBSearchJobOptions
- callback: HarpeeResponseCallback<T>
Returns Promise<void>
- Defined in core/harpee-logger.ts:394

Class HarpeeLogger

Hierarchy

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns HarpeeLogger

Properties

Static _schemaConfig

Methods

deleteRecordsBefore

Type Parameters

Type Parameters

T = IHarperDBMessageResponse

Parameters

options: IHarperDBDeleteRecordsOptions

Returns Promise<IHarpeeResponse<T>>

Type Parameters

Type Parameters

T = IHarperDBMessageResponse

Parameters

options: IHarperDBDeleteRecordsOptions

callback: HarpeeResponseCallback<T>

Returns Promise<void>

deleteTransactionLogsBefore

Type Parameters

Type Parameters

T = unknown

Parameters

options: IHarperDBDeleteTransLogOptions

Returns Promise<IHarpeeResponse<T>>

Type Parameters

Type Parameters

T = unknown

Parameters

options: IHarperDBDeleteTransLogOptions

callback: HarpeeResponseCallback<T>

Returns Promise<void>

getJob

Type Parameters

Type Parameters

T = object[]

Parameters

options: { id: string }

id: string

Returns Promise<IHarpeeResponse<T>>

Type Parameters

Type Parameters

T = object[]

Parameters

options: { id: string }

id: string

callback: HarpeeResponseCallback<T>

Returns Promise<void>

readLog

Type Parameters

Type Parameters

T = object

Parameters

options: IHarpeeReadLogOptions

Returns Promise<IHarpeeResponse<T>>

Type Parameters

Type Parameters

T = object

Parameters

options: IHarpeeReadLogOptions

callback: HarpeeResponseCallback<T>

Returns Promise<void>

readTransactionLog

Type Parameters

Type Parameters

T = object[]

Parameters

options: IHarpeeUtilOptions

Returns Promise<IHarpeeResponse<T>>

Type Parameters

Type Parameters

`Static` _schemaConfig