Snowpipe Streaming Node.js SDK v1.4.0
    Preparing search index...

    Function createClient

    • Create a new streaming ingest client. Each client is tied to a single database, schema, and pipe. To ingest into multiple pipes, create multiple clients.

      Either profilePath or properties must be provided for authentication. If both are provided, properties takes precedence for conflicting keys.

      Parameters

      • options: {
            clientName: string;
            dbName: string;
            pipeName: string;
            profilePath?: string;
            properties?: Record<string, string>;
            schemaName: string;
        }

        Client configuration

        • clientName: string

          A unique name to identify this client instance, used for tracking and debugging purposes.

        • dbName: string

          The name of the Snowflake database where data will be ingested.

        • pipeName: string

          The name of the pipe that will be used for streaming ingestion.

        • OptionalprofilePath?: string

          Path to a JSON file containing connection properties and authentication information.

        • Optionalproperties?: Record<string, string>

          Connection properties and authentication information. Common properties include account, user, private_key, url.

        • schemaName: string

          The name of the schema within the database.

      Returns Promise<StreamingIngestClient>

      StreamingIngestError If client creation fails

    Settings

    Member Visibility