@undefineds.co/xpod 0.3.58 → 0.3.61

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

@@ -1,6 +1,10 @@
 import type { Quad } from '@rdfjs/types';
-import type { RdfDerivedIndexRefreshResult, RdfEngineLike, RdfEngineStorageStats, RdfIndexPutOptions, RdfQuery, RdfQueryResult, RdfPatternQuery, RdfQuadIndexScanResult, RdfSourceInput } from './types';
+import { type PostgresRdfTextIndexOptions } from './PostgresRdfTextIndex';
+import { type PostgresRdfVectorIndexOptions } from './PostgresRdfVectorIndex';
+import type { RdfDerivedIndexMaintenanceResult, RdfDerivedIndexRefreshOptions, RdfDerivedIndexRefreshResult, RdfEngineLike, RdfEngineStorageStats, RdfStorageStatsOptions, RdfIndexPutOptions, RdfBoundedPathSearchOptions, RdfBoundedPathSearchResult, RdfMaterializedViewActivationInput, RdfMaterializedViewActivationResult, RdfMaterializedViewBindingSource, RdfMaterializedViewBuildInput, RdfMaterializedViewBuildResult, RdfMaterializedViewReadResult, RdfSchemaExplorerOptions, RdfSchemaExplorerResult, RdfTextChunkInput, RdfTextIndexLike, RdfTextIndexOptions, RdfTextSearchOptions, RdfTextSearchResult, RdfTextSourceInput, RdfQuery, RdfQueryResult, RdfPgAccelerationProfile, RdfPgAccelerationStats, RdfPatternQuery, RdfQueryCacheScope, RdfQuadIndexScanResult, RdfSourceInput, RdfVectorChunkInput, RdfVectorIndexLike, RdfVectorIndexOptions, RdfVectorSearchOptions, RdfVectorSearchResult, RdfVectorSourceInput, RdfTermRewriteInput, RdfTermRewriteResult, RdfNativeSparqlQueryOptions, RdfNativeSparqlResult } from './types';
 import type { QuintPattern } from '../quint/types';
+type RdfTextIndexInput = PostgresRdfTextIndexOptions | RdfTextIndexOptions | RdfTextIndexLike;
+type RdfVectorIndexInput = PostgresRdfVectorIndexOptions | RdfVectorIndexOptions | RdfVectorIndexLike;
 export interface PostgresRdfEngineOptions {
     driver?: 'pglite' | 'pg';
     dataDir?: string;
@@ -12,42 +16,239 @@ export interface PostgresRdfEngineOptions {
     password?: string;
     pool?: any;
     autoOpen?: boolean;
+    queryResultCacheEnabled?: boolean;
+    queryResultCacheMaxEntries?: number;
+    queryResultCacheTtlMs?: number;
+    queryResultCacheMaxBytes?: number;
+    materializedResultCacheEnabled?: boolean;
+    materializedResultCacheMaxEntries?: number;
+    materializedResultCacheTtlMs?: number;
+    materializedResultCacheMaxBytes?: number;
+    derivedCacheMaxBytes?: number;
+    derivedCacheScopeMaxBytes?: number;
+    queryTemplateCacheMaxEntries?: number;
+    queryTemplateCacheTtlMs?: number;
+    queryExplainSlowMs?: number;
+    queryExplainLargeScanRows?: number;
+    queryExplainSlowQueryMaxEntries?: number;
+    rdfAccelerationProfile?: RdfPgAccelerationProfile;
+    rdfAccelerationRequiredCapabilities?: string[];
+    deferPgCustomIndexInitialization?: boolean;
+    maintenanceIntervalMs?: number;
+    maintenanceSourceBatchSize?: number;
+    maintenanceLeaseTtlMs?: number;
+    maintenanceLeaseOwner?: string;
+    numericAggregateFactsCutoverMaxSourceRows?: number;
+    textIndex?: RdfTextIndexInput;
+    vectorIndex?: RdfVectorIndexInput;
+    nativeSparqlEnabled?: boolean;
 }
 export declare class PostgresRdfEngine implements RdfEngineLike {
+    private readonly logger;
     private executor;
     private termDictionary;
     private initialized;
     private initializing;
     private readonly pgOptions;
+    private pgAcceleration;
+    private readonly queryTemplateCache;
+    private queryTemplateCacheHits;
+    private queryTemplateCacheMisses;
+    private queryTemplateCacheEvictions;
+    private compiledSqlTemplateCacheHits;
+    private compiledSqlTemplateCacheMisses;
+    private compiledSqlTemplateCacheEvictions;
+    private queryResultCacheCounters;
+    private materializedResultCacheCounters;
+    private derivedCacheEvictions;
+    private readonly copyFromRowsStats;
+    private slowQueryHistory;
+    private plannerHistogramCache;
     private sharedPoolConfig;
     private pglite;
     private pgPool;
+    private pgCustomIndexesReady;
+    private readonly textIndex?;
+    private readonly vectorIndex?;
+    private readonly ownsTextIndex;
+    private readonly ownsVectorIndex;
+    private readonly maintenanceLeaseOwner;
+    private maintenanceTimer?;
+    private maintenanceRunning;
+    private lifecycleStatus;
+    private lifecycleOpenCount;
+    private lastOpenStartedAt?;
+    private lastReadyAt?;
+    private lastOpenDurationMs?;
+    private lastOpenFailedAt?;
+    private lastOpenError?;
+    private lastColdStart?;
+    readonly sparqlQuery?: (query: string, options: RdfNativeSparqlQueryOptions) => Promise<RdfNativeSparqlResult>;
     constructor(options: PostgresRdfEngineOptions);
     open(): Promise<void>;
     close(): Promise<void>;
+    private executeNativeSparql;
+    private probeNativeSparql;
+    maintainDerivedIndexes(): Promise<RdfDerivedIndexMaintenanceResult>;
     put(quads: Quad | Quad[], options?: RdfIndexPutOptions): Promise<void>;
     replaceSource(quads: Quad[], source: RdfSourceInput): Promise<void>;
     deleteSource(source: string): Promise<number>;
+    moveSource(oldSource: string, next: RdfSourceInput): Promise<number>;
     delete(pattern: QuintPattern): Promise<number>;
     applyDelta(deletes: QuintPattern[], inserts: Quad[], options?: RdfIndexPutOptions): Promise<{
         deletedRows: number;
         insertedRows: number;
     }>;
+    rewriteTerms(input: RdfTermRewriteInput): Promise<RdfTermRewriteResult>;
     scan(query: RdfPatternQuery): Promise<RdfQuadIndexScanResult>;
+    indexTextSource(source: RdfTextSourceInput, text: string, chunks?: RdfTextChunkInput[]): Promise<void>;
+    deleteTextSource(source: string): Promise<number>;
+    searchText(options: RdfTextSearchOptions | string): Promise<RdfTextSearchResult[]>;
+    indexVectorSource(source: RdfVectorSourceInput, chunks: RdfVectorChunkInput[]): Promise<void>;
+    deleteVectorSource(source: string): Promise<number>;
+    searchVector(options: RdfVectorSearchOptions): Promise<RdfVectorSearchResult[]>;
+    materializeView(input: RdfMaterializedViewBuildInput): Promise<RdfMaterializedViewBuildResult>;
+    readMaterializedView(source: RdfMaterializedViewBindingSource): Promise<RdfMaterializedViewReadResult | undefined>;
+    activateMaterializedView(source: RdfMaterializedViewActivationInput): Promise<RdfMaterializedViewActivationResult>;
+    deleteMaterializedView(source: RdfMaterializedViewBindingSource): Promise<number>;
+    exploreSchema(options?: RdfSchemaExplorerOptions): Promise<RdfSchemaExplorerResult>;
+    searchPaths(options: RdfBoundedPathSearchOptions): Promise<RdfBoundedPathSearchResult>;
+    private pathEdgesForFrontier;
+    private materializePathStates;
+    private expandMaterializedViewSources;
     query(query: RdfQuery): Promise<RdfQueryResult>;
-    refreshDerivedIndexes(): Promise<RdfDerivedIndexRefreshResult>;
-    storageStats(): Promise<RdfEngineStorageStats>;
+    invalidateQueryResultCache(scope?: RdfQueryCacheScope): Promise<number>;
+    private clearQueryCaches;
+    private invalidateAccessControlQueryCaches;
+    private accessControlInvalidationScopes;
+    refreshDerivedIndexes(options?: RdfDerivedIndexRefreshOptions): Promise<RdfDerivedIndexRefreshResult>;
+    ensurePgCustomIndexes(): Promise<RdfPgAccelerationStats>;
+    storageStats(options?: RdfStorageStatsOptions): Promise<RdfEngineStorageStats>;
+    private lifecycleStats;
+    private pgAccelerationStats;
+    private pgCustomIndexStats;
     private initializeSchema;
+    private initializePgCustomIndexes;
+    private initializeQueryResultCacheSchema;
+    private initializeMaterializedResultCacheSchema;
+    private initializeMaterializedViewSchema;
     private ensureCompatibleSchemaVersion;
     private initializeRdf3xSchema;
+    private initializeDirtySourceQueueSchema;
+    private initializeAccessControlOverrideSchema;
     private dropRdf3xDerivedSchema;
     private clearRdf3xDerivedTables;
     private rebuildRdf3xDerivedIndexes;
+    private refreshRdf3xDirtyDerivedIndexes;
+    private refreshDirtyGraphProjection;
+    private refreshDirtyPairProjection;
+    private refreshDirtyTermProjection;
+    private dirtyProjectionStats;
+    private clearRdf3xDirtyTables;
+    private dirtySourceQueueCutoff;
+    private dirtySourceQueueCount;
+    private normalizeDirtySourceBatchSize;
+    private clearDirtySourceQueue;
+    private tryClaimMaintenanceLease;
+    private startMaintenanceScheduler;
+    private stopMaintenanceScheduler;
+    private estimateDirtyRefreshScanRows;
+    private refreshPlannerStats;
     private scanNative;
+    private tryScanPgCustomIndexAny;
+    private nativeScanCanUseLimitEarlyStop;
     private scanPostFilter;
-    private queryNative;
+    private buildPgValuesJoins;
+    private queryRdf3x;
+    private choosePgRequiredSourceIndex;
+    private estimatePgRequiredSourceRows;
+    private estimatePgRequiredSourceVariableDistinctRows;
+    private estimatePgPatternVariableDistinctRows;
+    private estimatePgSearchRowsByBoundSources;
     private queryFacts;
+    private readQueryResultCache;
+    private readMaterializedResultCache;
+    private resolveQueryTemplate;
+    private recordCompiledSqlTemplate;
+    private resolveMaterializedResult;
+    private writeQueryResultCache;
+    private writeMaterializedResultCache;
+    private pruneQueryResultCache;
+    private pruneMaterializedResultCache;
+    private pruneQueryResultCachePayloadBytes;
+    private pruneMaterializedResultCachePayloadBytes;
+    private pruneDerivedCacheBudget;
+    private pruneDerivedCacheScopeBudgets;
+    private derivedCacheRowCandidates;
+    private queryTemplateCacheCandidates;
+    private deleteDerivedCacheCandidate;
+    private deleteRowsAndCount;
+    private isQueryResultCacheEnabled;
+    private isMaterializedResultCacheEnabled;
+    private queryResultCacheMaxEntries;
+    private materializedResultCacheMaxEntries;
+    private queryResultCacheTtlMs;
+    private queryResultCacheMaxBytes;
+    private materializedResultCacheTtlMs;
+    private materializedResultCacheMaxBytes;
+    private derivedCacheMaxBytes;
+    private derivedCacheScopeMaxBytes;
+    private queryTemplateCacheMaxEntries;
+    private queryTemplateCacheTtlMs;
+    private pruneQueryTemplateCache;
+    private pruneQueryTemplateCacheByteBudget;
+    private queryTemplateCacheStats;
+    private queryTemplateCacheMemoryBytes;
+    private queryTemplateCacheEntryBytes;
+    private compiledSqlTemplateCacheEntryCount;
+    private deleteQueryTemplateCacheEntry;
+    private probePgAcceleration;
+    private probeXpodRdfAccelerationProvider;
+    private disabledPgAccelerationStats;
+    private requiredPgAccelerationCapabilities;
+    private canUsePgAccelerationCapability;
+    private activePgAccelerationOperators;
+    private effectivePgAccelerationActiveOperators;
+    private pgCustomIndexBuildIsDeferred;
+    private pgAccelerationCapabilityProviders;
+    private preferredPgAccelerationProvider;
+    private engineSqlPgAccelerationCapabilities;
+    private pgAccelerationActiveMarkersForQuery;
+    private pgAccelerationActiveMarkersForScan;
+    private withPgAccelerationFallbackPlan;
+    private unsupportedPgAccelerationMarkers;
+    private unsupportedPgAccelerationCapabilities;
+    private withPostgresQueryExplain;
+    private postgresQueryPlannerExplain;
+    private usedPgNativeCapabilities;
+    private rejectedPgNativeOperators;
+    private queryHasGraphPrefix;
+    private queryHasSubjectStarShape;
+    private queryPlannerRuntimeExplain;
+    private queryPlannerStaleStatsExplain;
+    private queryPlannerSlowQueryExplain;
+    private recordSlowQuerySnapshot;
+    private slowQueryDerivedCacheExplain;
+    private slowQueryStats;
+    private trimSlowQueryHistory;
+    private queryExplainSlowMs;
+    private queryExplainLargeScanRows;
+    private queryExplainSlowQueryMaxEntries;
+    private queryPlannerHistogramHints;
+    private cachedPlannerHistogramDistributions;
+    private pgAccelerationCapabilitiesForQuery;
+    private pgAccelerationScanCapabilities;
     private joinFactsPattern;
+    private joinFactsPatternPerBinding;
+    private tryJoinFactsPatternByBoundTerm;
+    private joinFactsTextSearch;
+    private joinFactsVectorSearch;
+    private joinFactsTextSearchByBoundSource;
+    private joinFactsVectorSearchByBoundSource;
+    private textSearchResults;
+    private appendTextSearchBackendPlan;
+    private appendVectorSearchBackendPlan;
+    private vectorSearchResults;
     private joinFactsOptionalGroup;
     private joinFactsUnionGroup;
     private applyFactsMinusGroup;
@@ -55,15 +256,47 @@ export declare class PostgresRdfEngine implements RdfEngineLike {
     private evaluateFactsDependentGroup;
     private applyFactsValues;
     private applyFactsBinds;
-    private queryNativeAggregate;
-    private canNativeAggregate;
-    private canNativeAggregateHaving;
+    private queryRdf3xAggregate;
+    private numericAggregateFactsCutoverDecision;
+    private numericAggregateFactsCutoverMaxSourceRows;
+    private tryQueryPgCustomIndexCount;
+    private pgCustomIndexCountAny;
+    private pgCustomIndexCountResult;
+    private tryQueryPgCustomIndexBgpCount;
+    private pgCustomIndexBgpCountAggregateSlot;
+    private tryQueryPgCustomIndexBgpGroupCount;
+    private tryQueryPgCustomIndexBgpNumericAggregate;
+    private pgCustomIndexNumericAggregateColumn;
+    private tryQueryPgCustomIndexDistinct;
+    private pgCustomIndexDistinctEmptyResult;
+    private tryQueryPgCustomIndexBgpJoin;
+    private pgCustomIndexBgpOrderPageTopNSql;
+    private tryQueryPgCustomIndexValuesJoin;
+    private pgCustomIndexBgpJoinShape;
+    private resolvePgCustomIndexGraphPrefix;
+    private pgCustomIndexGraphIdsForPrefix;
+    private pgValuePrefixConditions;
+    private pgCustomIndexGraphPrefixVariableName;
+    private pgCustomIndexInternalFiltersPlan;
+    private canUsePgCustomIndexResolvedJoinPattern;
+    private pgCustomIndexValuesShape;
+    private pgCustomIndexSlotFiltersShape;
+    private pgCustomIndexPrefixFilters;
+    private pgCustomIndexFullFilters;
+    private pgCustomIndexIdFilter;
+    private canUsePgCustomIndexResolvedPattern;
+    private canRdf3xAggregate;
+    private canRdf3xAggregateExpression;
+    private canRdf3xAggregateHaving;
     private compileAggregateColumn;
+    private numericAggregateExpression;
+    private postgresRdf3xAggregateMarker;
     private buildAggregateHavingClause;
     private buildAggregateOrderClause;
     private aggregateFilterValue;
-    private canTryNativeQuery;
-    private compileNativeJoinPatterns;
+    private canTryRdf3xQuery;
+    private compileRdf3xJoinPatterns;
+    private compileRdf3xValuesSources;
     private allFiltersPushed;
     private compilePushdownFilterWithIndexes;
     private isPushdownFilter;
@@ -76,6 +309,9 @@ export declare class PostgresRdfEngine implements RdfEngineLike {
     private termOperatorValueId;
     private compileScanSql;
     private compileJoinSql;
+    private slotTermRangePlanMarkers;
+    private appendSlotTermRangeConditions;
+    private filterRowsBySlotTermRanges;
     private appendResolvedPatternConditions;
     private appendPatternEqualityConditions;
     private appendTermFilterCondition;
@@ -88,6 +324,7 @@ export declare class PostgresRdfEngine implements RdfEngineLike {
     private choosePermutation;
     private permutation;
     private estimateResolvedRows;
+    private estimateResolvedDistinctRows;
     private orderJoinSources;
     private buildOrderClause;
     private buildJoinOrderClause;
@@ -97,9 +334,23 @@ export declare class PostgresRdfEngine implements RdfEngineLike {
     private indexMetrics;
     private localMetrics;
     private insertQuads;
+    private insertQuadRowsViaUnnest;
+    private insertQuadRowsViaStagingTable;
+    private quadRowsForSource;
+    private markDirtyQuads;
+    private markDirtyQuadRows;
+    private insertDirtyGraphIds;
+    private insertDirtyPairKeys;
+    private insertDirtyTermKeys;
     private withRetryableWrite;
     private deleteExactQuad;
     private upsertSource;
+    private markDirtySource;
+    private markDirtySourceRow;
+    private replaceAccessControlOverrideTargets;
+    private mergeAccessControlOverrideTargets;
+    private deleteAccessControlOverrideTargets;
+    private accessControlOverrideTargetsForSources;
     private findSourceRow;
     private bumpFactsDataVersion;
     private readFactsDataVersion;
@@ -107,10 +358,36 @@ export declare class PostgresRdfEngine implements RdfEngineLike {
     private ensureReady;
     private scalarCount;
     private factsStats;
+    private schemaGraphSuggestions;
+    private schemaPredicateSuggestions;
+    private schemaClassSuggestions;
+    private schemaTermSuggestions;
+    private literalDatatypeDistribution;
+    private cardinalityDistributions;
+    private graphCardinalityDistribution;
+    private predicateCardinalityDistribution;
+    private predicateObjectCardinalityDistribution;
+    private subjectPredicateCardinalityDistribution;
+    private cardinalityTerm;
     private rdf3xStats;
+    private queryResultCacheStats;
+    private materializedResultCacheStats;
+    private accessControlOverrideStats;
+    private derivedCacheStats;
+    private recordDerivedCacheEviction;
+    private recordQueryResultCacheCounter;
+    private recordMaterializedResultCacheCounter;
+    private derivedCacheEvictionCount;
+    private derivedCacheScopeStats;
+    private cachePayloadBytes;
+    private collectCacheSpaceObjects;
     private collectSpaceObjects;
     private requireExecutor;
+    private requireTextIndex;
+    private requireVectorIndex;
+    private assertSearchIndexesConfigured;
     private requireDictionary;
     private requiredTerm;
     private openExecutor;
 }
+export {};