Databricks SDK for JavaScript
    Preparing search index...

    Interface ProtobufTransformerOptions

    interface ProtobufTransformerOptions {
        descFilePath?: string;
        messageName?: string;
        parseMode?: ParseMode;
        recursiveFieldsMaxDepth?: number;
        schemaRegistry?: SchemaRegistryConfig;
    }
    Index

    Properties

    descFilePath? messageName? parseMode? recursiveFieldsMaxDepth? schemaRegistry?

    Properties

    descFilePath?: string

    Required: path to the .desc file (dbfs:/... or /Volumes/...).

    messageName?: string

    Required: fully-qualified message type name.

    parseMode?: ParseMode

    (Optional) Parse mode for Protobuf data. Valid values: FAILFAST, PERMISSIVE. Defaults to PERMISSIVE.

    recursiveFieldsMaxDepth?: number

    (Optional) Maximum expansion depth for recursive protobuf fields. Spark SQL does not natively support recursive types, so recursive fields are expanded up to this depth and truncated beyond it. Valid values: -1 (disallow recursive fields), 0 (drop), 1-10.

    schemaRegistry?: SchemaRegistryConfig

    (Optional) Schema registry to resolve the Protobuf schema at runtime instead of providing it via desc_file_path.

    Settings

    Member Visibility

    On This Page

    Properties