@ultipa-graph/ultipa-driver/dist/services/admin-service.d.ts

NodeJS SDK for Ultipa GQL

/**
 * Admin service handles administrative operations.
 */
import { ServiceContext } from './service-context';
import { CacheStats, CacheType, Statistics, CompactResult, ComputeTopologyResult, SystemMetrics } from '../types';
/**
 * Admin service for administrative operations.
 */
export declare class AdminService {
    private ctx;
    constructor(ctx: ServiceContext);
    /**
     * Pre-allocate parser instances.
     */
    warmupParser(count: number): Promise<void>;
    /**
     * Return cache statistics.
     */
    getCacheStats(cacheType?: CacheType): Promise<CacheStats>;
    /**
     * Clear the specified cache.
     */
    clearCache(cacheType?: CacheType): Promise<void>;
    /**
     * Return database statistics.
     */
    getStatistics(graphName?: string): Promise<Statistics>;
    /**
     * Invalidate the RBAC permission cache.
     */
    invalidatePermissionCache(username?: string): Promise<void>;
    /**
     * Trigger manual compaction of the database storage.
     */
    compact(): Promise<CompactResult>;
    /**
     * Return system-level metrics (CPU, memory, disk I/O, storage, network).
     */
    getSystemMetrics(): Promise<SystemMetrics>;
    /**
     * Wait for the computing engine topology to be ready.
     */
    waitForComputeTopology(graphName: string, timeoutMs?: number): Promise<ComputeTopologyResult>;
}