columna API reference - v0.3.0
    Preparing search index...

    Type Alias ReadKafkaOptions

    Connection / consume settings for DataFrame.readKafka.

    type ReadKafkaOptions = {
        brokers: string[] | string;
        client?: KafkaClient;
        clientId?: string;
        flatten?: boolean | KafkaFlattenOptions;
        fromBeginning?: boolean;
        groupId?: string;
        includeMeta?: boolean | KafkaMetaField[];
        keepAlive?: boolean;
        keyFormat?: KafkaCodec;
        maxWaitMs?: number;
        metaPrefix?: string;
        nMessages?: number;
        sasl?: KafkaSaslOptions;
        ssl?: boolean;
        topic: string;
        valueFormat?: KafkaCodec;
    }
    Index
    brokers client? clientId? flatten? fromBeginning? groupId? includeMeta? keepAlive? keyFormat? maxWaitMs? metaPrefix? nMessages? sasl? ssl? topic valueFormat?
    brokers: string[] | string

    Broker list, e.g. ['localhost:9092'] or 'host1:9092,host2:9092'.

    client?: KafkaClient

    Existing duck-typed client. When set, brokers / SSL / SASL are ignored (still require topic for the consume request).

    clientId?: string
    flatten?: boolean | KafkaFlattenOptions

    Flatten nested JSON objects into dotted columns (default true). Pass false to keep a single value column (objects stored as JSON text).

    fromBeginning?: boolean

    Start from earliest offset (default false → latest, then wait for new).

    groupId?: string

    Consumer group (default columna-<random>).

    includeMeta?: boolean | KafkaMetaField[]

    Include Kafka metadata columns (default true → topic, partition, offset, timestamp, key). Prefixed with metaPrefix (default _kafka_).

    keepAlive?: boolean

    Keep the underlying KafkaJS consumer open (caller must close via returned client — not used for one-shot API).

    keyFormat?: KafkaCodec

    Decode message key (default string).

    maxWaitMs?: number

    Max time to wait for messages in ms (default 10_000).

    metaPrefix?: string

    Prefix for metadata columns (default _kafka_).

    nMessages?: number

    Stop after this many messages (default 1000).

    sasl?: KafkaSaslOptions
    ssl?: boolean
    topic: string

    Topic to consume from.

    valueFormat?: KafkaCodec

    Decode message value (default auto → JSON when possible).

    Settings
    Member Visibility

    On This Page
    Properties