Class DatabaseConnection

Database connection class Provides connection management and query execution

Index

Constructors

Methods

close Close connect Connect getDriver GetDriver query Query test Test

Constructors

constructor

new DatabaseConnection(dbConfig: AutoDocConnectionConfig): DatabaseConnection
Parameters
- dbConfig: AutoDocConnectionConfig
Returns DatabaseConnection
- Defined in packages/DBAutoDoc/src/database/Database.ts:50

Methods

close

close(): Promise<void>
Returns Promise<void>
Deprecated
Use Close.
- Defined in packages/DBAutoDoc/src/database/Database.ts:92

Close

Close(): Promise<void>
Returns Promise<void>
- Defined in packages/DBAutoDoc/src/database/Database.ts:87

connect

connect(): Promise<void>
Returns Promise<void>
Deprecated
Use Connect.
- Defined in packages/DBAutoDoc/src/database/Database.ts:59

Connect

Connect(): Promise<void>
Returns Promise<void>
- Defined in packages/DBAutoDoc/src/database/Database.ts:54

getDriver

getDriver(): BaseAutoDocDriver
Returns BaseAutoDocDriver
Deprecated
Use GetDriver.
- Defined in packages/DBAutoDoc/src/database/Database.ts:102

GetDriver

GetDriver(): BaseAutoDocDriver
Returns BaseAutoDocDriver
- Defined in packages/DBAutoDoc/src/database/Database.ts:97

query

query<T = any>(
queryText: string,
maxRetries?: number,
): Promise<{ data?: T[]; errorMessage?: string; success: boolean }>
Type Parameters
- T = any
Parameters
- queryText: string
- maxRetries: number = 3
Returns Promise<{ data?: T[]; errorMessage?: string; success: boolean }>
Deprecated
Use Query.
- Defined in packages/DBAutoDoc/src/database/Database.ts:80

Query

Query<T = any>(
queryText: string,
maxRetries?: number,
): Promise<{ data?: T[]; errorMessage?: string; success: boolean }>
Type Parameters
- T = any
Parameters
- queryText: string
- maxRetries: number = 3
Returns Promise<{ data?: T[]; errorMessage?: string; success: boolean }>
- Defined in packages/DBAutoDoc/src/database/Database.ts:72

test

test(): Promise<{ message: string; success: boolean }>
Returns Promise<{ message: string; success: boolean }>
Deprecated
Use Test.
- Defined in packages/DBAutoDoc/src/database/Database.ts:68

Test

Test(): Promise<{ message: string; success: boolean }>
Returns Promise<{ message: string; success: boolean }>
- Defined in packages/DBAutoDoc/src/database/Database.ts:63