@lde/sparql-qlever 0.15.2 → 0.15.3

package/README.md

@@ -10,6 +10,20 @@ Only **one** index is cached at a time. In a multi-dataset pipeline, each datase
 
 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).
 
+## Networking (Docker mode)
+
+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:
+
+```ts
+const { importer, server } = createQlever({
+  mode: 'docker',
+  image: 'adfreiburg/qlever:latest',
+  network: 'app_default',
+  containerName: 'qlever',
+});
+server.queryEndpoint.toString(); // 'http://qlever:7001/sparql'
+```
+
 ## Configuration
 
 `createQlever()` accepts `indexOptions` and `serverOptions` to tune QLever's index builder and server respectively.

package/dist/createQlever.d.ts

@@ -18,6 +18,22 @@ export type QleverOptions = {
     mode: 'docker';
     image: string;
     containerName?: string;
+    network?: never;
+} | {
+    mode: 'docker';
+    image: string;
+    /**
+     * Docker network to attach the QLever containers to. Set this when the
+     * consumer itself runs in a container on that network: the query
+     * endpoint is then addressed by `containerName` as hostname instead of
+     * a host-published `localhost` port, which a containerized consumer on
+     * a bridge network cannot reach. Leave unset when the consumer runs on
+     * the host (or shares the QLever container’s network namespace), where
+     * `localhost` is correct.
+     */
+    network: string;
+    /** The hostname at which consumers on the network reach the endpoint. */
+    containerName: string;
 } | {
     mode: 'native';
 });

package/dist/createQlever.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createQlever.d.ts","sourceRoot":"","sources":["../src/createQlever.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,UAAU,EAEX,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAC7D,OAAO,EAAE,mBAAmB,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAE1D,MAAM,MAAM,aAAa,GAAG;IAC1B,wDAAwD;IACxD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oBAAoB;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,6FAA6F;IAC7F,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,mDAAmD;IACnD,YAAY,CAAC,EAAE,kBAAkB,CAAC;IAClC,sDAAsD;IACtD,aAAa,CAAC,EAAE,mBAAmB,CAAC;CACrC,GAAG,CACA;IACE,IAAI,EAAE,QAAQ,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,GACD;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CACrB,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,aAAa;;;EA4BlD"}
+{"version":3,"file":"createQlever.d.ts","sourceRoot":"","sources":["../src/createQlever.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,UAAU,EAEX,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAC7D,OAAO,EAAE,mBAAmB,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAE1D,MAAM,MAAM,aAAa,GAAG;IAC1B,wDAAwD;IACxD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oBAAoB;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,6FAA6F;IAC7F,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,mDAAmD;IACnD,YAAY,CAAC,EAAE,kBAAkB,CAAC;IAClC,sDAAsD;IACtD,aAAa,CAAC,EAAE,mBAAmB,CAAC;CACrC,GAAG,CACA;IACE,IAAI,EAAE,QAAQ,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,KAAK,CAAC;CACjB,GACD;IACE,IAAI,EAAE,QAAQ,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd;;;;;;;;OAQG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB,yEAAyE;IACzE,aAAa,EAAE,MAAM,CAAC;CACvB,GACD;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CACrB,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,aAAa;;;EAoClD"}

package/dist/createQlever.js

@@ -11,12 +11,18 @@ import { Server } from './server.js';
  */
 export function createQlever(options) {
     const port = options.port ?? 7001;
+    // On a shared network the endpoint is reached by container name, so don't
+    // claim a host port.
+    const hostname = options.mode === 'docker' && options.network
+        ? options.containerName
+        : undefined;
     const taskRunner = options.mode === 'docker'
         ? new DockerTaskRunner({
             image: options.image,
             containerName: options.containerName,
             mountDir: options.dataDir,
-            port,
+            network: options.network,
+            port: hostname ? undefined : port,
         })
         : new NativeTaskRunner({ cwd: options.dataDir });
     return {
@@ -31,6 +37,7 @@ export function createQlever(options) {
             taskRunner,
             indexName: options.indexName ?? 'data',
             port,
+            hostname,
             qleverOptions: options.serverOptions,
         }),
     };

package/dist/server.d.ts

@@ -13,8 +13,9 @@ export declare class Server<Task> implements SparqlServer {
     private readonly indexName;
     private task?;
     private readonly port;
+    private readonly hostname;
     private readonly qleverOptions;
-    constructor({ taskRunner, indexName, port, qleverOptions }: Arguments<Task>);
+    constructor({ taskRunner, indexName, port, hostname, qleverOptions, }: Arguments<Task>);
     start(): Promise<void>;
     stop(): Promise<void>;
     get queryEndpoint(): URL;
@@ -24,6 +25,13 @@ export interface Arguments<Task> {
     indexName: string;
     /** @default 7001 */
     port?: number;
+    /**
+     * Hostname at which consumers reach the query endpoint. Defaults to
+     * `localhost`, which is right whenever the server shares the consumer’s
+     * network namespace: a native process, a host-published Docker port, or
+     * QLever running inside the consumer’s own container.
+     */
+    hostname?: string;
     qleverOptions?: QleverServerOptions;
 }
 //# sourceMappingURL=server.d.ts.map

package/dist/server.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAG9C,MAAM,WAAW,mBAAmB;IAClC,qEAAqE;IACrE,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,4CAA4C;IAC5C,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,mEAAmE;IACnE,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAYD,qBAAa,MAAM,CAAC,IAAI,CAAE,YAAW,YAAY;IAC/C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAmB;IAC9C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,IAAI,CAAC,CAAO;IACpB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAS;IAC9B,OAAO,CAAC,QAAQ,CAAC,aAAa,CACgB;gBAElC,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,EAAE,aAAa,EAAE,EAAE,SAAS,CAAC,IAAI,CAAC;IAO9D,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAmBtB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAOlC,IAAW,aAAa,IAAI,GAAG,CAE9B;CACF;AAED,MAAM,WAAW,SAAS,CAAC,IAAI;IAC7B,UAAU,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,oBAAoB;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,mBAAmB,CAAC;CACrC"}
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAG9C,MAAM,WAAW,mBAAmB;IAClC,qEAAqE;IACrE,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,4CAA4C;IAC5C,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,mEAAmE;IACnE,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAYD,qBAAa,MAAM,CAAC,IAAI,CAAE,YAAW,YAAY;IAC/C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAmB;IAC9C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,IAAI,CAAC,CAAO;IACpB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAS;IAC9B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,aAAa,CACgB;gBAElC,EACV,UAAU,EACV,SAAS,EACT,IAAI,EACJ,QAAQ,EACR,aAAa,GACd,EAAE,SAAS,CAAC,IAAI,CAAC;IAQL,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAmBtB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAOlC,IAAW,aAAa,IAAI,GAAG,CAE9B;CACF;AAED,MAAM,WAAW,SAAS,CAAC,IAAI;IAC7B,UAAU,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,oBAAoB;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,mBAAmB,CAAC;CACrC"}

package/dist/server.js

@@ -8,11 +8,13 @@ export class Server {
     indexName;
     task;
     port;
+    hostname;
     qleverOptions;
-    constructor({ taskRunner, indexName, port, qleverOptions }) {
+    constructor({ taskRunner, indexName, port, hostname, qleverOptions, }) {
         this.taskRunner = taskRunner;
         this.indexName = indexName;
         this.port = port ?? 7001;
+        this.hostname = hostname ?? 'localhost';
         this.qleverOptions = { ...defaultQleverServerOptions, ...qleverOptions };
     }
     async start() {
@@ -37,6 +39,6 @@ export class Server {
         }
     }
     get queryEndpoint() {
-        return new URL(`http://localhost:${this.port}/sparql`);
+        return new URL(`http://${this.hostname}:${this.port}/sparql`);
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lde/sparql-qlever",
-  "version": "0.15.2",
+  "version": "0.15.3",
   "repository": {
     "url": "git+https://github.com/ldelements/lde.git",
     "directory": "packages/sparql-qlever"
@@ -29,7 +29,7 @@
     "@lde/sparql-importer": "^0.6.9",
     "@lde/sparql-server": "^0.4.14",
     "@lde/task-runner": "^0.2.13",
-    "@lde/task-runner-docker": "^0.2.15",
+    "@lde/task-runner-docker": "^0.2.16",
     "@lde/task-runner-native": "^0.2.16",
     "@lde/wait-for-sparql": "^0.2.16",
     "rdf-parse": "^5.0.0",