Skip to content

Commit d86a334

Browse files
committed
fix: update docs
1 parent 7b1df54 commit d86a334

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

docs/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,17 +46,21 @@ adbc_connect(options) -> BIGINT
4646
```
4747

4848
**Parameters:**
49+
4950
- `options`: A STRUCT or MAP containing connection options
5051

5152
**Required Options:**
53+
5254
- `driver`: Driver name (e.g., `'sqlite'`, `'postgresql'`), path to shared library, or path to manifest file (`.toml`)
5355

5456
**Connection Options:**
57+
5558
- `uri`: Connection URI (driver-specific)
5659
- `username`: Database username
5760
- `password`: Database password
5861

5962
**Driver Resolution Options:**
63+
6064
- `entrypoint`: Custom driver entrypoint function name (rarely needed)
6165
- `search_paths`: Additional paths to search for driver manifests (colon-separated on Unix, semicolon on Windows)
6266
- `use_manifests`: Enable/disable manifest search (default: `'true'`). Set to `'false'` to only use direct library paths.
@@ -124,6 +128,7 @@ adbc_disconnect(connection_id) -> BOOLEAN
124128
```
125129

126130
**Parameters:**
131+
127132
- `connection_id`: Connection handle from `adbc_connect`
128133

129134
**Returns:** `true` on success.
@@ -143,6 +148,7 @@ adbc_set_autocommit(connection_id, enabled) -> BOOLEAN
143148
```
144149

145150
**Parameters:**
151+
146152
- `connection_id`: Connection handle from `adbc_connect`
147153
- `enabled`: `true` to enable autocommit, `false` to disable
148154

@@ -173,6 +179,7 @@ adbc_commit(connection_id) -> BOOLEAN
173179
```
174180

175181
**Parameters:**
182+
176183
- `connection_id`: Connection handle from `adbc_connect`
177184

178185
**Returns:** `true` on success.
@@ -192,6 +199,7 @@ adbc_rollback(connection_id) -> BOOLEAN
192199
```
193200

194201
**Parameters:**
202+
195203
- `connection_id`: Connection handle from `adbc_connect`
196204

197205
**Returns:** `true` on success.
@@ -221,6 +229,7 @@ adbc_scan(connection_id, query, [params := row(...)]) -> TABLE
221229
```
222230

223231
**Parameters:**
232+
224233
- `connection_id`: Connection handle from `adbc_connect`
225234
- `query`: SQL SELECT query to execute
226235
- `params` (optional): Query parameters as a STRUCT created with `row(...)`
@@ -254,6 +263,7 @@ adbc_execute(connection_id, statement) -> BIGINT
254263
```
255264

256265
**Parameters:**
266+
257267
- `connection_id`: Connection handle from `adbc_connect`
258268
- `statement`: SQL DDL or DML statement to execute
259269

@@ -288,6 +298,7 @@ adbc_insert(connection_id, table_name, <table>, [mode:=]) -> TABLE(rows_inserted
288298
```
289299

290300
**Parameters:**
301+
291302
- `connection_id`: Connection handle from `adbc_connect`
292303
- `table_name`: Target table name in the remote database
293304
- `<table>`: A subquery providing the data to insert
@@ -336,11 +347,13 @@ adbc_info(connection_id) -> TABLE(info_name VARCHAR, info_value VARCHAR)
336347
```
337348

338349
**Parameters:**
350+
339351
- `connection_id`: Connection handle from `adbc_connect`
340352

341353
**Returns:** A table with info_name and info_value columns.
342354

343355
**Common Info Names:**
356+
344357
- `vendor_name`: Database vendor (e.g., "SQLite", "PostgreSQL")
345358
- `vendor_version`: Database version
346359
- `driver_name`: ADBC driver name
@@ -375,12 +388,14 @@ adbc_tables(connection_id, [catalog:=], [schema:=], [table_name:=]) -> TABLE
375388
```
376389

377390
**Parameters:**
391+
378392
- `connection_id`: Connection handle from `adbc_connect`
379393
- `catalog` (optional): Filter by catalog name pattern
380394
- `schema` (optional): Filter by schema name pattern
381395
- `table_name` (optional): Filter by table name pattern
382396

383397
**Returns:** A table with columns:
398+
384399
- `catalog_name`: Catalog containing the table
385400
- `schema_name`: Schema containing the table
386401
- `table_name`: Name of the table
@@ -408,6 +423,7 @@ adbc_table_types(connection_id) -> TABLE(table_type VARCHAR)
408423
```
409424

410425
**Parameters:**
426+
411427
- `connection_id`: Connection handle from `adbc_connect`
412428

413429
**Returns:** A table with a single `table_type` column listing supported types.
@@ -437,13 +453,15 @@ adbc_columns(connection_id, [catalog:=], [schema:=], [table_name:=], [column_nam
437453
```
438454

439455
**Parameters:**
456+
440457
- `connection_id`: Connection handle from `adbc_connect`
441458
- `catalog` (optional): Filter by catalog name pattern
442459
- `schema` (optional): Filter by schema name pattern
443460
- `table_name` (optional): Filter by table name pattern
444461
- `column_name` (optional): Filter by column name pattern
445462

446463
**Returns:** A table with columns:
464+
447465
- `catalog_name`: Catalog containing the table
448466
- `schema_name`: Schema containing the table
449467
- `table_name`: Name of the table
@@ -490,12 +508,14 @@ adbc_schema(connection_id, table_name, [catalog:=], [schema:=]) -> TABLE
490508
```
491509

492510
**Parameters:**
511+
493512
- `connection_id`: Connection handle from `adbc_connect`
494513
- `table_name`: Name of the table to get the schema for
495514
- `catalog` (optional): Catalog containing the table
496515
- `schema` (optional): Database schema containing the table
497516

498517
**Returns:** A table with columns:
518+
499519
- `field_name`: Name of the field/column
500520
- `field_type`: Arrow data type (e.g., "int64", "utf8", "float64", "timestamp[us]")
501521
- `nullable`: Whether the field allows NULL values
@@ -561,20 +581,23 @@ library = "/usr/local/lib/libadbc_driver_sqlite.dylib"
561581
The extension searches for driver manifests in these locations (in order):
562582

563583
**macOS:**
584+
564585
1. `ADBC_DRIVER_PATH` environment variable (colon-separated paths)
565586
2. `$VIRTUAL_ENV/etc/adbc/drivers` (if in a Python virtual environment)
566587
3. `$CONDA_PREFIX/etc/adbc/drivers` (if in a Conda environment)
567588
4. `~/Library/Application Support/ADBC/Drivers`
568589
5. `/etc/adbc/drivers`
569590

570591
**Linux:**
592+
571593
1. `ADBC_DRIVER_PATH` environment variable (colon-separated paths)
572594
2. `$VIRTUAL_ENV/etc/adbc/drivers` (if in a Python virtual environment)
573595
3. `$CONDA_PREFIX/etc/adbc/drivers` (if in a Conda environment)
574596
4. `~/.config/adbc/drivers`
575597
5. `/etc/adbc/drivers`
576598

577599
**Windows:**
600+
578601
1. `ADBC_DRIVER_PATH` environment variable (semicolon-separated paths)
579602
2. Registry: `HKEY_CURRENT_USER\SOFTWARE\ADBC\Drivers\{name}`
580603
3. `%LOCAL_APPDATA%\ADBC\Drivers`

0 commit comments

Comments
 (0)