Skip to content

Commit bb89c5d

Browse files
committed
docs: clarify tuning options JSON
1 parent 94ae140 commit bb89c5d

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

docs/guide_db.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,10 @@ First complete the [installation instructions](index.md).
105105
```java
106106
SQLiteConfig config = new SQLiteConfig();
107107
// config.setReadOnly(true)
108-
// (or other sqlite-jdbc settings as needed)
108+
// (or other sqlite-jdbc options as needed)
109109
java.util.Properties props = config.toProperties();
110110
props.setProperty("genomicsqlite.config_json", "{}");
111+
// GenomicSQLite tuning options as JSON text ^^^^
111112

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

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

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

0 commit comments

Comments
 (0)