falkordb/dist/src/clients/nullClient.d.ts

A FalkorDB javascript library

import { RedisCommandArgument } from "@redis/client/dist/lib/commands";
import { QueryOptions } from "../commands";
import FalkorDB from "../falkordb";
import { ConstraintType, EntityType } from "../graph";
import { Client } from "./client";
import { SingleGraphConnection } from "./single";
import { MemoryUsageOptions, MemoryUsageReply } from "../commands/MEMORY_USAGE";
import { UdfListReply } from "../commands/UDF_LIST";
/**
 * The `NullClient` class is a placeholder implementation of the `Client` interface.
 *
 * This class is designed to be used in scenarios where a client is required, but no actual
 * implementation is available. All methods in this class throw a "Method not implemented."
 * error, indicating that the functionality has not been provided.
 *
 * The `NullClient` can serve as a base class or a stub for future implementations, or as a
 * fallback in cases where a functional client is not needed or cannot be instantiated.
 *
 */
export declare class NullClient implements Client {
    getConnection(): Promise<SingleGraphConnection>;
    init(_falkordb: FalkorDB): Promise<void>;
    list(): Promise<Array<string>>;
    configGet(_configKey: string): Promise<(string | number)[] | (string | number)[][]>;
    configSet(_configKey: string, _value: number | string): Promise<void>;
    info(_section?: string): Promise<(string | string[])[]>;
    query<_T>(_graph: string, _query: RedisCommandArgument, _options?: QueryOptions): Promise<any>;
    profile<_T>(_graph: string, _query: RedisCommandArgument): Promise<any>;
    roQuery<_T>(_graph: string, _query: RedisCommandArgument, _options?: QueryOptions): Promise<any>;
    copy<_T>(_srcGraph: string, _destGraph: string): Promise<any>;
    delete(_graph: string): Promise<void>;
    explain(_graph: string, _query: string): Promise<any>;
    slowLog(_graph: string): Promise<{
        timestamp: Date;
        command: string;
        query: string;
        took: number;
    }[]>;
    memoryUsage(_graph: string, _options?: MemoryUsageOptions): Promise<MemoryUsageReply>;
    constraintCreate(_graph: string, _constraintType: ConstraintType, _entityType: EntityType, _label: string, ..._properties: string[]): Promise<void>;
    constraintDrop(_graph: string, _constraintType: ConstraintType, _entityType: EntityType, _label: string, ..._properties: string[]): Promise<void>;
    udfLoad(_name: string, _script: string | Function, _replace?: boolean): Promise<string>;
    udfList(_lib?: string, _withCode?: boolean): Promise<UdfListReply>;
    udfFlush(): Promise<string>;
    udfDelete(_lib: string): Promise<string>;
    quit(): Promise<void>;
    disconnect(): Promise<void>;
}