Skip to content

Commit

Permalink
docs: clarify tuning options JSON
Browse files Browse the repository at this point in the history
  • Loading branch information
mlin committed Dec 28, 2022
1 parent 94ae140 commit bb89c5d
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/guide_db.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,10 @@ First complete the [installation instructions](index.md).
```java
SQLiteConfig config = new SQLiteConfig();
// config.setReadOnly(true)
// (or other sqlite-jdbc settings as needed)
// (or other sqlite-jdbc options as needed)
java.util.Properties props = config.toProperties();
props.setProperty("genomicsqlite.config_json", "{}");
// GenomicSQLite tuning options as JSON text ^^^^

Connection dbconn = DriverManager.getConnection(
"jdbc:genomicsqlite:" + dbfileName, props
Expand All @@ -129,7 +130,7 @@ First complete the [installation instructions](index.md).
std::unique_ptr<SQLite::Database> GenomicSQLiteOpen(
const std::string &db_filename,
int flags = 0,
const std::string &config_json = "{}"
const std::string &config_json = "{}" // tuning options as JSON text
);
```

Expand All @@ -140,7 +141,7 @@ First complete the [installation instructions](index.md).
sqlite3 **ppDb,
std::string &errmsg_out,
int flags = 0, // as sqlite3_open_v2() e.g. SQLITE_OPEN_READONLY
const std::string &config_json = "{}"
const std::string &config_json = "{}" // tuning options as JSON text
) noexcept; // returns sqlite3_open_v2() code
```

Expand All @@ -152,7 +153,7 @@ First complete the [installation instructions](index.md).
char **pzErrMsg, /* if nonnull and an error occurs, set to error message
* which caller should sqlite3_free() */
int flags, /* as sqlite3_open_v2() e.g. SQLITE_OPEN_READONLY */
const char *config_json /* JSON text (may be null) */
const char *config_json /* tuning options as JSON text (may be null) */
); /* returns sqlite3_open_v2() code */
```

Expand Down

0 comments on commit bb89c5d

Please sign in to comment.