Skip to content

Commit acff5c5

Browse files
committed
deprecated the query
1 parent b977e9c commit acff5c5

File tree

10 files changed

+34
-11
lines changed

10 files changed

+34
-11
lines changed

src/connections/bigquery.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ export class BigQueryConnection extends SqlConnection {
204204
* @param parameters - An object containing the parameters to be used in the query.
205205
* @returns Promise<{ data: any, error: Error | null }>
206206
*/
207-
async query<T = Record<string, unknown>>(
207+
async internalQuery<T = Record<string, unknown>>(
208208
query: Query
209209
): Promise<QueryResult<T>> {
210210
try {

src/connections/index.ts

+4-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,10 @@ export abstract class Connection {
3232

3333
// Retrieve metadata about the database, useful for introspection.
3434
abstract fetchDatabaseSchema(): Promise<Database>;
35-
abstract raw(query: string): Promise<QueryResult>;
35+
abstract raw(
36+
query: string,
37+
params?: Record<string, unknown> | unknown[]
38+
): Promise<QueryResult>;
3639
abstract testConnection(): Promise<{ error?: string }>;
3740

3841
// Connection common operations that will be used by Outerbase

src/connections/motherduck.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ export class DuckDBConnection extends PostgreBaseConnection {
5151
* @param parameters - An object containing the parameters to be used in the query.
5252
* @returns Promise<{ data: any, error: Error | null }>
5353
*/
54-
async query<T = Record<string, unknown>>(
54+
async internalQuery<T = Record<string, unknown>>(
5555
query: Query
5656
): Promise<QueryResult<T>> {
5757
const connection = this.connection;

src/connections/mysql.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ export class MySQLConnection extends SqlConnection {
225225
return super.mapDataType(dataType);
226226
}
227227

228-
async query<T = Record<string, unknown>>(
228+
async internalQuery<T = Record<string, unknown>>(
229229
query: Query
230230
): Promise<QueryResult<T>> {
231231
try {

src/connections/postgre/postgresql.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export class PostgreSQLConnection extends PostgreBaseConnection {
2727
await this.client.end();
2828
}
2929

30-
async query<T = Record<string, unknown>>(
30+
async internalQuery<T = Record<string, unknown>>(
3131
query: Query
3232
): Promise<QueryResult<T>> {
3333
try {

src/connections/snowflake/snowflake.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ export class SnowflakeConnection extends PostgreBaseConnection {
175175
);
176176
}
177177

178-
async query<T = Record<string, unknown>>(
178+
async internalQuery<T = Record<string, unknown>>(
179179
query: Query
180180
): Promise<QueryResult<T>> {
181181
try {

src/connections/sql-base.ts

+22-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export abstract class SqlConnection extends Connection {
1616
abstract dialect: AbstractDialect;
1717
protected numberedPlaceholder = false;
1818

19-
abstract query<T = Record<string, unknown>>(
19+
abstract internalQuery<T = Record<string, unknown>>(
2020
query: Query
2121
): Promise<QueryResult<T>>;
2222

@@ -26,6 +26,23 @@ export abstract class SqlConnection extends Connection {
2626
return dataType;
2727
}
2828

29+
/**
30+
* This is a deprecated function, use raw instead. We keep this for
31+
* backward compatibility.
32+
*
33+
* @deprecated
34+
* @param query
35+
* @returns
36+
*/
37+
async query<T = Record<string, unknown>>(
38+
query: Query
39+
): Promise<QueryResult<T>> {
40+
return (await this.raw(
41+
query.query,
42+
query.parameters
43+
)) as QueryResult<T>;
44+
}
45+
2946
async raw(
3047
query: string,
3148
params?: Record<string, unknown> | unknown[]
@@ -51,7 +68,10 @@ export abstract class SqlConnection extends Connection {
5168

5269
// Named placeholder
5370
const { query: newQuery, bindings } = namedPlaceholder(query, params!);
54-
return await this.query({ query: newQuery, parameters: bindings });
71+
return await this.internalQuery({
72+
query: newQuery,
73+
parameters: bindings,
74+
});
5575
}
5676

5777
async select(

src/connections/sqlite/cloudflare.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ export class CloudflareD1Connection extends SqliteBaseConnection {
107107
* @param parameters - An object containing the parameters to be used in the query.
108108
* @returns Promise<{ data: any, error: Error | null }>
109109
*/
110-
async query<T = Record<string, unknown>>(
110+
async internalQuery<T = Record<string, unknown>>(
111111
query: Query
112112
): Promise<QueryResult<T>> {
113113
if (!this.apiKey) throw new Error('Cloudflare API key is not set');

src/connections/sqlite/starbase.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ export class StarbaseConnection extends SqliteBaseConnection {
9090
* @param parameters - An object containing the parameters to be used in the query.
9191
* @returns Promise<{ data: any, error: Error | null }>
9292
*/
93-
async query<T = Record<string, unknown>>(
93+
async internalQuery<T = Record<string, unknown>>(
9494
query: Query
9595
): Promise<QueryResult<T>> {
9696
if (!this.url) throw new Error('Starbase URL is not set');

src/connections/sqlite/turso.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export class TursoConnection extends SqliteBaseConnection {
1616
this.client = client;
1717
}
1818

19-
async query<T = Record<string, unknown>>(
19+
async internalQuery<T = Record<string, unknown>>(
2020
query: Query
2121
): Promise<QueryResult<T>> {
2222
try {

0 commit comments

Comments
 (0)