zeroshade commented on code in PR #4091:
URL: https://github.com/apache/arrow-adbc/pull/4091#discussion_r2933101319
##########
javascript/lib/types.ts:
##########
@@ -243,32 +243,44 @@ export interface AdbcConnection {
/**
* Get a list of table types supported by the database.
*
- * @returns A RecordBatchReader containing a single string column of table
types.
+ * @returns A Promise resolving to an Apache Arrow Table with a single
string column of table types.
*/
- getTableTypes(): Promise<RecordBatchReader>
+ getTableTypes(): Promise<Table>
/**
* Get metadata about the driver and database.
*
* @param infoCodes Optional list of info codes to retrieve. Use the {@link
InfoCode} constants.
* If omitted, all available info is returned.
- * @returns A RecordBatchReader containing the requested metadata info.
+ * @returns A Promise resolving to an Apache Arrow Table containing the
requested metadata info.
*/
- getInfo(infoCodes?: InfoCode[]): Promise<RecordBatchReader>
+ getInfo(infoCodes?: InfoCode[]): Promise<Table>
/**
- * Execute a SQL query and return the results as a RecordBatchReader.
+ * Execute a SQL query and return all results as an Arrow Table.
*
* Convenience method that creates a statement, sets the SQL, optionally
binds
- * parameters, executes the query, and closes the statement. The reader
remains
- * valid after the statement is closed because the underlying iterator holds
its
- * own reference to the native resources.
+ * parameters, executes the query, and closes the statement.
+ * For large result sets, use {@link queryStream} to avoid loading
everything into memory.
*
* @param sql The SQL query to execute.
- * @param params Optional Arrow RecordBatch or Table to bind as parameters.
+ * @param params Optional Arrow Table to bind as parameters.
+ * @returns A Promise resolving to an Apache Arrow Table.
+ */
+ query(sql: string, params?: Table): Promise<Table>
Review Comment:
should the params be a record batch reader? or do we have a separate `bind`
option for that?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
