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

    Function createTableClient

    • Create a new streaming ingest client in table mode. The pipe name is derived from the table name by appending "-STREAMING". Each client is tied to a single database, schema, and (derived) pipe.

      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;
            profilePath?: string;
            properties?: Record<string, string>;
            schemaName: string;
            tableName: 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.

        • OptionalprofilePath?: string

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

        • Optionalproperties?: Record<string, string>

          Connection properties and authentication information.

        • schemaName: string

          The name of the schema within the database.

        • tableName: string

          The table name. The pipe name is derived as ${tableName}-STREAMING.

      Returns Promise<StreamingIngestClient>

      StreamingIngestError If client creation fails

    Settings

    Member Visibility