Skip to content

Commit 936cfaa

Browse files
authored
Merge pull request #198 from duckdb/jray/readme-fixes
README fixes
2 parents caa2ae2 + 66f49cd commit 936cfaa

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

api/pkgs/@duckdb/node-api/README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,26 @@ An API for using [DuckDB](https://duckdb.org/) in [Node](https://nodejs.org/).
44

55
This is a high-level API meant for applications.
66
It depends on low-level bindings that adhere closely to [DuckDB's C API](https://duckdb.org/docs/api/c/overview),
7-
available separately as [@duckdb/duckdb-bindings](https://www.npmjs.com/package/@duckdb/node-bindings).
7+
available separately as [@duckdb/node-bindings](https://www.npmjs.com/package/@duckdb/node-bindings).
88

99
## Features
1010

11-
### Main differences from [duckdb-node](https://www.npmjs.com/package/duckdb)
12-
- Native support for Promises; no need for separate [duckdb-async](https://www.npmjs.com/package/duckdb-async) wrapper.
13-
- DuckDB-specific API; not based on the [SQLite Node API](https://www.npmjs.com/package/sqlite3).
14-
- Lossless & efficent support for values of all [DuckDB data types](https://duckdb.org/docs/sql/data_types/overview).
15-
- Wraps [released DuckDB binaries](https://github.com/duckdb/duckdb/releases) instead of rebuilding DuckDB.
16-
- Built on [DuckDB's C API](https://duckdb.org/docs/api/c/overview); exposes more functionality.
11+
### Main Differences from [duckdb-node](https://www.npmjs.com/package/duckdb)
12+
* Native support for Promises; no need for separate [duckdb-async](https://www.npmjs.com/package/duckdb-async) wrapper.
13+
* DuckDB-specific API; not based on the [SQLite Node API](https://www.npmjs.com/package/sqlite3).
14+
* Lossless & efficent support for values of all [DuckDB data types](https://duckdb.org/docs/sql/data_types/overview).
15+
* Wraps [released DuckDB binaries](https://github.com/duckdb/duckdb/releases) instead of rebuilding DuckDB.
16+
* Built on [DuckDB's C API](https://duckdb.org/docs/api/c/overview); exposes more functionality.
1717

1818
### Roadmap
1919

2020
Some features are not yet complete:
21-
- Binding and appending the MAP and UNION data types
22-
- Appending default values row-by-row
23-
- User-defined types & functions
24-
- Profiling info
25-
- Table description
26-
- APIs for Arrow
21+
* Binding and appending the MAP and UNION data types
22+
* Appending default values row-by-row
23+
* User-defined types & functions
24+
* Profiling info
25+
* Table description
26+
* APIs for Arrow
2727

2828
See the [issues list on GitHub](https://github.com/duckdb/duckdb-node-neo/issues)
2929
for the most up-to-date roadmap.
@@ -118,13 +118,13 @@ Connections will be disconnected automatically soon after their reference
118118
is dropped, but you can also disconnect explicitly if and when you want:
119119

120120
```ts
121-
connection.disconnect();
121+
connection.disconnectSync();
122122
```
123123

124124
or, equivalently:
125125

126126
```ts
127-
connection.close();
127+
connection.closeSync();
128128
```
129129

130130
### Run SQL
@@ -847,13 +847,13 @@ appender.appendInteger(123);
847847
appender.appendVarchar('mallard');
848848
appender.endRow();
849849

850-
appender.flush();
850+
appender.flushSync();
851851

852852
appender.appendInteger(17);
853853
appender.appendVarchar('goose');
854854
appender.endRow();
855855

856-
appender.close(); // also flushes
856+
appender.closeSync(); // also flushes
857857
```
858858

859859
### Append Data Chunk
@@ -878,7 +878,7 @@ chunk.setColumns([
878878
// ]);
879879

880880
appender.appendDataChunk(chunk);
881-
appender.flush();
881+
appender.flushSync();
882882
```
883883

884884
See "Specifying Values" above for how to supply values to the appender.

0 commit comments

Comments
 (0)