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

NodeJS SDK for Ultipa GQL

/**
 * Bulk import service handles bulk import session management.
 */
import { ServiceContext } from './service-context';
import { BulkImportOptions, BulkImportSession, CheckpointResult, EndBulkImportResult, AbortBulkImportResult, BulkImportStatus } from '../types';
/**
 * Bulk import service for managing bulk import sessions.
 */
export declare class BulkImportService {
    private ctx;
    constructor(ctx: ServiceContext);
    /**
     * Start a bulk import session for optimized high-throughput inserts.
     * @param graphName Target graph name
     * @param options Optional bulk import configuration
     */
    startBulkImport(graphName: string, options?: BulkImportOptions): Promise<BulkImportSession>;
    /** @deprecated Checkpoint is no longer needed. */
    checkpoint(sessionId: string): Promise<CheckpointResult>;
    /**
     * End the bulk import session with a final checkpoint.
     * @param sessionId Bulk import session ID
     */
    endBulkImport(sessionId: string): Promise<EndBulkImportResult>;
    /**
     * Cancel the bulk import session without final sync.
     * @param sessionId Bulk import session ID
     */
    abortBulkImport(sessionId: string): Promise<AbortBulkImportResult>;
    /**
     * Return the current status of a bulk import session.
     * @param sessionId Bulk import session ID
     */
    getBulkImportStatus(sessionId: string): Promise<BulkImportStatus>;
}