@datapos/datapos-shared
    Preparing search index...

    Interface Connector

    Interfaces/Types - Connector.

    interface Connector {
        abortController?: AbortController;
        config: {
            category: { id: string; label: string } | null;
            categoryId: "application" | "curatedDataset" | "database" | "fileStore";
            description: {
                "en-au"?: string;
                "en-gb"?: string;
                "en-us"?: string;
                "es-es"?: string;
            };
            firstCreatedAt?: number;
            icon: string
            | null;
            iconDark: string | null;
            id: string;
            implementations: {
                [key: string]: {
                    activeConnectionCount?: number;
                    authMethodId: "apiKey" | "disabled" | "oAuth2" | "none";
                    canDescribe?: boolean;
                    id?: string;
                    label?: {
                        "en-au": string;
                        "en-gb": string;
                        "en-us": string;
                        "es-es": string;
                    };
                    maxConnectionCount?: number;
                    params?: { [key: string]: string }[];
                };
            };
            label: {
                "en-au"?: string;
                "en-gb"?: string;
                "en-us"?: string;
                "es-es"?: string;
            };
            lastUpdatedAt: number
            | null;
            operations: (
                | "abortOperation"
                | "authenticateConnection"
                | "createObject"
                | "describeConnection"
                | "dropObject"
                | "findObject"
                | "getReadableStream"
                | "getRecord"
                | "listNodes"
                | "previewObject"
                | "removeRecords"
                | "retrieveChunks"
                | "retrieveRecords"
                | "upsertRecords"
            )[];
            status: | {
                color: "amber"
                | "green"
                | "red"
                | "other";
                id: string;
                label: string;
            }
            | null;
            statusId: | "alpha"
            | "beta"
            | "generalAvailability"
            | "notApplicable"
            | "preAlpha"
            | "proposed"
            | "releaseCandidate"
            | "unavailable"
            | "underReview";
            typeId: "connector";
            usageId: "bidirectional"
            | "destination"
            | "source"
            | "unknown";
            vendorAccountURL: string | null;
            vendorDocumentationURL: string | null;
            vendorHomeURL: string | null;
            version: string;
        };
        connectionConfig: ConnectionConfig;
        tools: ConnectorTools;
        abortOperation?(connector: Connector): void;
        authenticateConnection?(
            accountId: string,
            windowCenterX: number,
            windowCenterY: number,
        ): Window;
        createObject?(
            connector: Connector,
            settings: CreateSettings,
        ): Promise<void>;
        describeConnection?(
            connector: Connector,
            settings: ConnectorOperationSettings,
        ): Promise<DescribeResult>;
        dropObject?(connector: Connector, settings: DropSettings): Promise<void>;
        findObject?(
            connector: Connector,
            findSettings: FindSettings,
        ): Promise<FindResult>;
        getReadableStream?(
            connector: Connector,
            getSettings: GetReadableStreamSettings,
        ): Promise<GetReadableStreamResult>;
        getRecord?(
            connector: Connector,
            getSettings: GetRecordSettings,
        ): Promise<GetRecordResult>;
        listNodes?(
            connector: Connector,
            settings: ListSettings,
        ): Promise<ListResult>;
        previewObject?(
            connector: Connector,
            settings: PreviewSettings,
        ): Promise<PreviewResult>;
        removeRecords?(
            connector: Connector,
            settings: RemoveSettings,
        ): Promise<void>;
        retrieveChunks?(
            connector: Connector,
            settings: RetrieveChunksSettings,
            chunk: (records: (string[] | Record<string, unknown>)[]) => void,
            complete: (result: RetrieveChunksSummary) => void,
        ): Promise<void>;
        retrieveRecords?(
            connector: Connector,
            settings: RetrieveRecordsSettings,
            chunk: (records: (string[] | Record<string, unknown>)[]) => void,
            complete: (result: RetrieveRecordsSummary) => void,
        ): Promise<void>;
        upsertRecords?(
            connector: Connector,
            settings: UpsertSettings,
        ): Promise<void>;
    }

    Hierarchy

    • Component
      • Connector
    Index

    Properties

    abortController? config connectionConfig tools

    Methods

    abortOperation? authenticateConnection? createObject? describeConnection? dropObject? findObject? getReadableStream? getRecord? listNodes? previewObject? removeRecords? retrieveChunks? retrieveRecords? upsertRecords?

    Properties

    abortController?: AbortController
    config: {
        category: { id: string; label: string } | null;
        categoryId: "application" | "curatedDataset" | "database" | "fileStore";
        description: {
            "en-au"?: string;
            "en-gb"?: string;
            "en-us"?: string;
            "es-es"?: string;
        };
        firstCreatedAt?: number;
        icon: string
        | null;
        iconDark: string | null;
        id: string;
        implementations: {
            [key: string]: {
                activeConnectionCount?: number;
                authMethodId: "apiKey" | "disabled" | "oAuth2" | "none";
                canDescribe?: boolean;
                id?: string;
                label?: {
                    "en-au": string;
                    "en-gb": string;
                    "en-us": string;
                    "es-es": string;
                };
                maxConnectionCount?: number;
                params?: { [key: string]: string }[];
            };
        };
        label: {
            "en-au"?: string;
            "en-gb"?: string;
            "en-us"?: string;
            "es-es"?: string;
        };
        lastUpdatedAt: number
        | null;
        operations: (
            | "abortOperation"
            | "authenticateConnection"
            | "createObject"
            | "describeConnection"
            | "dropObject"
            | "findObject"
            | "getReadableStream"
            | "getRecord"
            | "listNodes"
            | "previewObject"
            | "removeRecords"
            | "retrieveChunks"
            | "retrieveRecords"
            | "upsertRecords"
        )[];
        status: | {
            color: "amber"
            | "green"
            | "red"
            | "other";
            id: string;
            label: string;
        }
        | null;
        statusId: | "alpha"
        | "beta"
        | "generalAvailability"
        | "notApplicable"
        | "preAlpha"
        | "proposed"
        | "releaseCandidate"
        | "unavailable"
        | "underReview";
        typeId: "connector";
        usageId: "bidirectional"
        | "destination"
        | "source"
        | "unknown";
        vendorAccountURL: string | null;
        vendorDocumentationURL: string | null;
        vendorHomeURL: string | null;
        version: string;
    }
    connectionConfig: ConnectionConfig
    tools: ConnectorTools

    Methods

    • Parameters

      • accountId: string
      • windowCenterX: number
      • windowCenterY: number

      Returns Window

    Settings

    Member Visibility

    On This Page

    Properties
    Methods