dirsql 0.3.111 → 0.3.112

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/docs/reference/sdk.md +11 -2
  2. package/package.json +11 -11
@@ -88,7 +88,7 @@ DirSQL::builder()
88
88
  .poll_interval(duration) // optional; watch-loop cadence, default 200ms
89
89
  .build() // -> Result<DirSQL> (synchronous scan)
90
90
  // Shortcuts: DirSQL::new(root, tables), DirSQL::with_ignore(root, tables, ignore),
91
- // DirSQL::from_config(root), DirSQL::from_config_path(path)
91
+ // DirSQL::from_config_path(path) // reads an explicit config file
92
92
  ```
93
93
 
94
94
  :::
@@ -97,6 +97,15 @@ Creates a SQLite index over a directory. The index root is the explicit
97
97
  `root` when given, else the **process cwd** — the `config` file's location
98
98
  never sets the root.
99
99
 
100
+ Constructing with **neither a `config` nor programmatic `tables`** serves the
101
+ **baked-in default** `files` table (one row per file, over the root) — the
102
+ same shipped default the CLI serves with no [`-c`](./cli.md#default-mode), not
103
+ an empty index. There is no implicit `<root>/.dirsql.toml` discovery: to read a
104
+ config on disk, pass its path via `config` (Rust: `.config(path)` /
105
+ `DirSQL::from_config_path(path)`). The root-joining `DirSQL::from_config(root)`
106
+ shortcut was removed in #603 — use
107
+ `DirSQL::from_config_path(root.join(".dirsql.toml"))`.
108
+
100
109
  **Parameters:**
101
110
 
102
111
  - `root` — Directory to index. When omitted, the index roots at the process
@@ -294,7 +303,7 @@ let sync: DirSQL = db.sync()?; // unwrap the inner sync handle
294
303
  ```
295
304
 
296
305
  Shortcuts mirror `DirSQL`: `AsyncDirSQL::new`, `with_ignore`,
297
- `from_config`, `from_config_path`. Unlike the Python/TypeScript SDKs,
306
+ `from_config_path`. Unlike the Python/TypeScript SDKs,
298
307
  methods called before `ready().await` completes return a "not ready" error
299
308
  rather than waiting — an intentional, language-idiomatic difference.
300
309
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "dirsql",
3
- "version": "0.3.111",
3
+ "version": "0.3.112",
4
4
  "description": "Ephemeral SQL index over a local directory",
5
5
  "license": "MIT",
6
6
  "repository": "https://github.com/thekevinscott/dirsql",
@@ -212,15 +212,15 @@
212
212
  ]
213
213
  },
214
214
  "optionalDependencies": {
215
- "@dirsql/lib-linux-x64-gnu": "0.3.111",
216
- "@dirsql/lib-linux-arm64-gnu": "0.3.111",
217
- "@dirsql/lib-darwin-x64": "0.3.111",
218
- "@dirsql/lib-darwin-arm64": "0.3.111",
219
- "@dirsql/lib-win32-x64-msvc": "0.3.111",
220
- "@dirsql/cli-linux-x64-gnu": "0.3.111",
221
- "@dirsql/cli-linux-arm64-gnu": "0.3.111",
222
- "@dirsql/cli-darwin-x64": "0.3.111",
223
- "@dirsql/cli-darwin-arm64": "0.3.111",
224
- "@dirsql/cli-win32-x64-msvc": "0.3.111"
215
+ "@dirsql/lib-linux-x64-gnu": "0.3.112",
216
+ "@dirsql/lib-linux-arm64-gnu": "0.3.112",
217
+ "@dirsql/lib-darwin-x64": "0.3.112",
218
+ "@dirsql/lib-darwin-arm64": "0.3.112",
219
+ "@dirsql/lib-win32-x64-msvc": "0.3.112",
220
+ "@dirsql/cli-linux-x64-gnu": "0.3.112",
221
+ "@dirsql/cli-linux-arm64-gnu": "0.3.112",
222
+ "@dirsql/cli-darwin-x64": "0.3.112",
223
+ "@dirsql/cli-darwin-arm64": "0.3.112",
224
+ "@dirsql/cli-win32-x64-msvc": "0.3.112"
225
225
  }
226
226
  }