Skip to content

Fix Readme flow #119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 8, 2022
Merged

Fix Readme flow #119

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4bb3765
Fix Readme flow
hfhbd Dec 8, 2022
3fd5f15
Update README.md
hfhbd Dec 8, 2022
4ce7a28
Update README.md
hfhbd Dec 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ You can use the driver with [SQLDelight](https://github.com/cashapp/sqldelight),

You need `libpq` installed and available in your `$PATH`.

This package is uploaded to MavenCentral and supports macOS, linuxX64.
This package is uploaded to MavenCentral and supports macOS and linuxX64.
Windows is currently not supported.

````kotlin
Expand Down Expand Up @@ -64,13 +64,18 @@ The identifier is used to reuse prepared statements.
driver.execute(identifier = null, sql = "INSERT INTO foo VALUES (42)", parameters = 0, binders = null)
```

It also supports a real lazy cursor or a flow:
It also supports a real lazy cursor or a Flow. The `fetchSize` parameter defines how many rows are fetched at once:

```kotlin
val names: List<String> = driver.executeQueryWithNativeCursor(
val names: List<Simple> = driver.executeQueryWithNativeCursor(
identifier = null,
sql = "SELECT name from foo",
sql = "SELECT index, name, bytes FROM foo",
mapper = { cursor ->
// You need to call `next` and use the cursor to return your type, here it is a list.

// Important, don't leak this cursor, eg by returning a Sequence,
// otherwise the cursor will be closed before fetching rows.
// If you need to use an async iterator, use the `Flow` overload, `executeQueryAsFlow`.
buildList {
while (cursor.next()) {
add(
Expand All @@ -88,9 +93,9 @@ val names: List<String> = driver.executeQueryWithNativeCursor(
binders = null
)

val namesFlow: Flow<String> = driver.executeQueryAsFlow(
val namesFlow: Flow<Simple> = driver.executeQueryAsFlow(
identifier = null,
sql = "SELECT name from foo",
sql = "SELECT index, name, bytes FROM foo",
mapper = { cursor ->
Simple(
index = cursor.getLong(0)!!.toInt(),
Expand All @@ -104,10 +109,10 @@ val namesFlow: Flow<String> = driver.executeQueryAsFlow(
)
```

And for bulk imports, use the `copy` method:
And for bulk imports, use the `copy` method. You need to enable `COPY` first:

```kotlin
driver.execute(514394779, """COPY foo FROM STDIN (FORMAT CSV)""", 0)
driver.execute(514394779, "COPY foo FROM STDIN (FORMAT CSV)", 0)
val rows = driver.copy("1,2,3\n4,5,6\n")
```

Expand Down