@undefineds.co/xpod 0.3.6 → 0.3.14

package/dist/storage/rdf/SolidRdfEngine.jsonld

@@ -0,0 +1,338 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/@undefineds.co/xpod/^0.0.0/components/context.jsonld"
+  ],
+  "@id": "npmd:@undefineds.co/xpod",
+  "components": [
+    {
+      "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine",
+      "@type": "Class",
+      "requireElement": "SolidRdfEngine",
+      "parameters": [
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine_options_index_path",
+          "range": "xsd:string"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine_options_index_debug",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              "xsd:boolean",
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          }
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine_options_textIndex_path",
+          "range": "xsd:string"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine_options_vectorIndex_path",
+          "range": "xsd:string"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine_options_vectorIndex_defaultMetric",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              {
+                "@type": "ParameterRangeUnion",
+                "parameterRangeElements": [
+                  {
+                    "@type": "ParameterRangeLiteral",
+                    "parameterRangeValueLiteral": "cosine"
+                  },
+                  {
+                    "@type": "ParameterRangeLiteral",
+                    "parameterRangeValueLiteral": "dot"
+                  },
+                  {
+                    "@type": "ParameterRangeLiteral",
+                    "parameterRangeValueLiteral": "euclidean"
+                  }
+                ]
+              },
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          }
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine_options_rdf3xIndex_path",
+          "range": "xsd:string"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine_options_rdf3xIndex_debug",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              "xsd:boolean",
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          }
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine_options_compatibilityStore",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              "undefineds:dist/storage/quint/types.jsonld#QuintStore",
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          }
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine_options_autoOpen",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              "xsd:boolean",
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          }
+        }
+      ],
+      "memberFields": [
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_index",
+          "memberFieldName": "index",
+          "range": "undefineds:dist/storage/rdf/RdfQuadIndex.jsonld#RdfQuadIndex"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_textIndex",
+          "memberFieldName": "textIndex",
+          "range": "undefineds:dist/storage/rdf/RdfTextIndex.jsonld#RdfTextIndex"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_vectorIndex",
+          "memberFieldName": "vectorIndex",
+          "range": "undefineds:dist/storage/rdf/RdfVectorIndex.jsonld#RdfVectorIndex"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_rdf3xIndex",
+          "memberFieldName": "rdf3xIndex",
+          "range": "undefineds:dist/storage/rdf/Rdf3xTripleIndex.jsonld#Rdf3xTripleIndex"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_ownsIndex",
+          "memberFieldName": "ownsIndex"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_ownsTextIndex",
+          "memberFieldName": "ownsTextIndex"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_ownsVectorIndex",
+          "memberFieldName": "ownsVectorIndex"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_ownsRdf3xIndex",
+          "memberFieldName": "ownsRdf3xIndex"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_compatibilityStore",
+          "memberFieldName": "compatibilityStore"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_shadowComparator",
+          "memberFieldName": "shadowComparator"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_queryEngine",
+          "memberFieldName": "queryEngine"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_constructor",
+          "memberFieldName": "constructor"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_open",
+          "memberFieldName": "open"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_close",
+          "memberFieldName": "close"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_put",
+          "memberFieldName": "put"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_replaceSource",
+          "memberFieldName": "replaceSource"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_deleteSource",
+          "memberFieldName": "deleteSource"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_delete",
+          "memberFieldName": "delete"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_scan",
+          "memberFieldName": "scan"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_query",
+          "memberFieldName": "query"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_indexTextSource",
+          "memberFieldName": "indexTextSource"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_deleteTextSource",
+          "memberFieldName": "deleteTextSource"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_searchText",
+          "memberFieldName": "searchText"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_indexVectorSource",
+          "memberFieldName": "indexVectorSource"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_deleteVectorSource",
+          "memberFieldName": "deleteVectorSource"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_searchVector",
+          "memberFieldName": "searchVector"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_shadowScan",
+          "memberFieldName": "shadowScan"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_shadowRdf3xScan",
+          "memberFieldName": "shadowRdf3xScan"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_shadowRdf3xJoin",
+          "memberFieldName": "shadowRdf3xJoin"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_supportsPrimary",
+          "memberFieldName": "supportsPrimary"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_requireTextIndex",
+          "memberFieldName": "requireTextIndex"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_requireVectorIndex",
+          "memberFieldName": "requireVectorIndex"
+        },
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine__member_requireRdf3xIndex",
+          "memberFieldName": "requireRdf3xIndex"
+        }
+      ],
+      "constructorArguments": [
+        {
+          "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine_options__constructorArgument",
+          "fields": [
+            {
+              "keyRaw": "index",
+              "value": {
+                "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine_options_index__constructorArgument",
+                "fields": [
+                  {
+                    "keyRaw": "path",
+                    "value": {
+                      "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine_options_index_path"
+                    }
+                  },
+                  {
+                    "keyRaw": "debug",
+                    "value": {
+                      "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine_options_index_debug"
+                    }
+                  }
+                ]
+              }
+            },
+            {
+              "keyRaw": "textIndex",
+              "value": {
+                "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine_options_textIndex__constructorArgument",
+                "fields": [
+                  {
+                    "keyRaw": "path",
+                    "value": {
+                      "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine_options_textIndex_path"
+                    }
+                  }
+                ]
+              }
+            },
+            {
+              "keyRaw": "vectorIndex",
+              "value": {
+                "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine_options_vectorIndex__constructorArgument",
+                "fields": [
+                  {
+                    "keyRaw": "path",
+                    "value": {
+                      "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine_options_vectorIndex_path"
+                    }
+                  },
+                  {
+                    "keyRaw": "defaultMetric",
+                    "value": {
+                      "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine_options_vectorIndex_defaultMetric"
+                    }
+                  }
+                ]
+              }
+            },
+            {
+              "keyRaw": "rdf3xIndex",
+              "value": {
+                "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine_options_rdf3xIndex__constructorArgument",
+                "fields": [
+                  {
+                    "keyRaw": "path",
+                    "value": {
+                      "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine_options_rdf3xIndex_path"
+                    }
+                  },
+                  {
+                    "keyRaw": "debug",
+                    "value": {
+                      "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine_options_rdf3xIndex_debug"
+                    }
+                  }
+                ]
+              }
+            },
+            {
+              "keyRaw": "compatibilityStore",
+              "value": {
+                "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine_options_compatibilityStore"
+              }
+            },
+            {
+              "keyRaw": "autoOpen",
+              "value": {
+                "@id": "undefineds:dist/storage/rdf/SolidRdfEngine.jsonld#SolidRdfEngine_options_autoOpen"
+              }
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}

package/dist/storage/rdf/SolidRdfSparqlEngine.d.ts

@@ -0,0 +1,92 @@
+import type { AsyncIterator } from 'asynciterator';
+import type { Bindings } from '@comunica/types';
+import type { Quad } from '@rdfjs/types';
+import type { SparqlEngine } from '../sparql/SubgraphQueryEngine';
+import type { ShadowRdfQuintStore } from './ShadowRdfQuintStore';
+import type { SolidRdfEngine } from './SolidRdfEngine';
+export interface SolidRdfSparqlEngineOptions {
+    rdfEngine: SolidRdfEngine;
+    fallback: SparqlEngine;
+    shadowStore?: ShadowRdfQuintStore;
+    enablePrimary?: boolean;
+    onFallback?: (reason: SolidRdfSparqlFallback) => void;
+}
+export interface SolidRdfSparqlFallback {
+    operation: 'queryBindings' | 'queryBoolean' | 'queryQuads' | 'queryVoid' | 'constructGraph' | 'listGraphs';
+    reason: string;
+}
+export type SolidRdfSparqlOperation = SolidRdfSparqlFallback['operation'];
+export interface SolidRdfSparqlOperationCount {
+    operation: SolidRdfSparqlOperation;
+    primaryCount: number;
+    fallbackCount: number;
+    totalCount: number;
+    fallbackRate: number;
+    primaryDurationMs: number;
+    fallbackDurationMs: number;
+}
+export interface SolidRdfSparqlPrimaryMetric {
+    operation: SolidRdfSparqlOperation;
+    durationMs: number;
+    scannedRows: number;
+    returnedRows: number;
+    plan: string[];
+    indexChoices: string[];
+}
+export interface SolidRdfSparqlFallbackMetric extends SolidRdfSparqlFallback {
+    durationMs: number;
+}
+export interface SolidRdfSparqlMetricsSnapshot {
+    primaryCount: number;
+    fallbackCount: number;
+    totalCount: number;
+    fallbackRate: number;
+    operationCounts: SolidRdfSparqlOperationCount[];
+    lastPrimary?: SolidRdfSparqlPrimaryMetric;
+    lastFallback?: SolidRdfSparqlFallbackMetric;
+}
+export interface SolidRdfSparqlFallbackBudget {
+    maxFallbackRate?: number;
+    maxFallbackCount?: number;
+    operations?: SolidRdfSparqlOperation[];
+}
+type BindingsStream = AsyncIterator<Bindings> & {
+    metadata?: () => Promise<{
+        variables: import('@rdfjs/types').Variable[];
+    }>;
+};
+export declare class SolidRdfSparqlEngine implements SparqlEngine {
+    private readonly adapter;
+    private readonly bindingsFactory;
+    private readonly rdfEngine;
+    private readonly fallback;
+    private readonly shadowStore?;
+    private readonly enablePrimary;
+    private readonly onFallback?;
+    private readonly operationCounts;
+    private lastPrimary?;
+    private lastFallback?;
+    constructor(rdfEngine: SolidRdfEngine, fallback: SparqlEngine, shadowStore?: ShadowRdfQuintStore, enablePrimary?: boolean, onFallback?: (reason: SolidRdfSparqlFallback) => void);
+    queryBindings(query: string, basePath: string): Promise<BindingsStream>;
+    queryBoolean(query: string, basePath: string): Promise<boolean>;
+    queryQuads(query: string, basePath: string): Promise<any>;
+    queryVoid(query: string, basePath: string): Promise<void>;
+    constructGraph(graph: string, basePath: string): Promise<AsyncIterator<Quad>>;
+    listGraphs(basePath: string): Promise<Set<string>>;
+    close(): Promise<void>;
+    getMetrics(): SolidRdfSparqlMetricsSnapshot;
+    assertFallbackBudget(budget?: SolidRdfSparqlFallbackBudget): void;
+    resetMetrics(): void;
+    private bindingsStream;
+    private bindings;
+    private fallbackWith;
+    private ensureReady;
+    private executeSelectPrimary;
+    private executeConstructPrimary;
+    private executeQuadsPrimary;
+    private executeDescribePrimary;
+    private recordPrimary;
+    private recordFallback;
+    private countsFor;
+}
+export {};