@lde/sparql-qlever 0.15.3 → 0.15.4

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/README.md +6 -46
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,45 +1,13 @@
1
- # SPARQL QLever
1
+ # @lde/sparql-qlever
2
2
 
3
3
  An adapter for the [QLever](https://github.com/ad-freiburg/qlever) SPARQL server.
4
4
 
5
- ## Index caching
5
+ ## Installation
6
6
 
7
- Building a QLever index is slow. To avoid rebuilding it on every pipeline run, the importer caches a single index and reuses it when the source data hasn't changed. On subsequent runs, indexing is skipped when the source file matches and hasn't been re-downloaded.
8
-
9
- Only **one** index is cached at a time. In a multi-dataset pipeline, each dataset overwrites the previous index. On re-run, the last-indexed dataset gets a cache hit while the others rebuild.
10
-
11
- Caching is enabled by default. Disable it by passing `cacheIndex: false` to `createQlever()` or the `Importer` constructor (e.g. driven by a `QLEVER_CACHE_INDEX=false` environment variable).
12
-
13
- ## Networking (Docker mode)
14
-
15
- By default `createQlever({ mode: 'docker' })` publishes QLever’s port on the host and addresses the query endpoint as `localhost` – correct when the consumer runs on the host, or shares the QLever container’s network namespace. A consumer that itself runs in a container on a bridge network cannot reach a host-published port; pass `network` (a Docker network the consumer is attached to) together with `containerName`, and QLever joins that network with the endpoint addressed by container name instead:
16
-
17
- ```ts
18
- const { importer, server } = createQlever({
19
- mode: 'docker',
20
- image: 'adfreiburg/qlever:latest',
21
- network: 'app_default',
22
- containerName: 'qlever',
23
- });
24
- server.queryEndpoint.toString(); // 'http://qlever:7001/sparql'
7
+ ```sh
8
+ npm install @lde/sparql-qlever
25
9
  ```
26
10
 
27
- ## Configuration
28
-
29
- `createQlever()` accepts `indexOptions` and `serverOptions` to tune QLever's index builder and server respectively.
30
-
31
- ### Server options (`serverOptions`)
32
-
33
- Passed to `qlever-server` at startup.
34
-
35
- | Option | Description | Default |
36
- | ----------------------- | ------------------------------------------------ | ------- |
37
- | `memory-max-size` | Maximum memory for query processing and caching. | `'4G'` |
38
- | `default-query-timeout` | Default query timeout. | `'30s'` |
39
- | `cache-max-size` | Maximum cache size for query results. | – |
40
-
41
- Example:
42
-
43
11
  ```ts
44
12
  const { importer, server } = createQlever({
45
13
  mode: 'docker',
@@ -51,14 +19,6 @@ const { importer, server } = createQlever({
51
19
  });
52
20
  ```
53
21
 
54
- ### Index options (`indexOptions`)
55
-
56
- Passed to `qlever-index` during import.
22
+ ## Documentation
57
23
 
58
- | Option | Description | Default |
59
- | ------------------------------- | --------------------------------------------------------------------------------------------- | ----------- |
60
- | `ascii-prefixes-only` | Enable faster parsing for well-behaved TTL files. | `true` |
61
- | `num-triples-per-batch` | Triples per batch; lower values reduce memory usage. | `3_000_000` |
62
- | `stxxl-memory` | Memory budget for sorting during the index build. | `'10G'` |
63
- | `parallel-parsing` | Parse input in parallel. | `true` |
64
- | `only-pso-and-pos-permutations` | Build only PSO and POS permutations. Faster, but queries with predicate variables won't work. | `false` |
24
+ See the [full documentation](https://ldelements.org/reference/sparql-qlever).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lde/sparql-qlever",
3
- "version": "0.15.3",
3
+ "version": "0.15.4",
4
4
  "repository": {
5
5
  "url": "git+https://github.com/ldelements/lde.git",
6
6
  "directory": "packages/sparql-qlever"
@@ -31,7 +31,7 @@
31
31
  "@lde/task-runner": "^0.2.13",
32
32
  "@lde/task-runner-docker": "^0.2.16",
33
33
  "@lde/task-runner-native": "^0.2.16",
34
- "@lde/wait-for-sparql": "^0.2.16",
34
+ "@lde/wait-for-sparql": "^0.2.17",
35
35
  "rdf-parse": "^5.0.0",
36
36
  "rdf-serialize": "^5.1.0",
37
37
  "tslib": "^2.3.0",