@ydbjs/api/dist/gen/protos/ydb_formats_pb.d.ts

TypeScript gRPC service definitions and protobuf types for all YDB APIs. Enables strongly-typed client generation and low-level protocol access.

import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
import type { Message } from "@bufbuild/protobuf";
/**
 * Describes the file protos/ydb_formats.proto.
 */
export declare const file_protos_ydb_formats: GenFile;
/**
 * @generated from message Ydb.Formats.ArrowBatchSettings
 */
export type ArrowBatchSettings = Message<"Ydb.Formats.ArrowBatchSettings"> & {
    /**
     * @generated from field: bytes schema = 1;
     */
    schema: Uint8Array;
};
/**
 * Describes the message Ydb.Formats.ArrowBatchSettings.
 * Use `create(ArrowBatchSettingsSchema)` to create a new message.
 */
export declare const ArrowBatchSettingsSchema: GenMessage<ArrowBatchSettings>;
/**
 * @generated from message Ydb.Formats.CsvSettings
 */
export type CsvSettings = Message<"Ydb.Formats.CsvSettings"> & {
    /**
     * Number of rows to skip before CSV data. It should be present only in the first upsert of CSV file.
     *
     * @generated from field: uint32 skip_rows = 1;
     */
    skipRows: number;
    /**
     * Fields delimiter in CSV file. It's "," if not set.
     *
     * @generated from field: bytes delimiter = 2;
     */
    delimiter: Uint8Array;
    /**
     * String value that would be interpreted as NULL.
     *
     * @generated from field: bytes null_value = 3;
     */
    nullValue: Uint8Array;
    /**
     * First not skipped line is a CSV header (list of column names).
     *
     * @generated from field: bool header = 4;
     */
    header: boolean;
    /**
     * @generated from field: Ydb.Formats.CsvSettings.Quoting quoting = 5;
     */
    quoting?: CsvSettings_Quoting;
};
/**
 * Describes the message Ydb.Formats.CsvSettings.
 * Use `create(CsvSettingsSchema)` to create a new message.
 */
export declare const CsvSettingsSchema: GenMessage<CsvSettings>;
/**
 * @generated from message Ydb.Formats.CsvSettings.Quoting
 */
export type CsvSettings_Quoting = Message<"Ydb.Formats.CsvSettings.Quoting"> & {
    /**
     * @generated from field: bool disabled = 1;
     */
    disabled: boolean;
    /**
     * @generated from field: bytes quote_char = 2;
     */
    quoteChar: Uint8Array;
    /**
     * @generated from field: bool double_quote_disabled = 3;
     */
    doubleQuoteDisabled: boolean;
};
/**
 * Describes the message Ydb.Formats.CsvSettings.Quoting.
 * Use `create(CsvSettings_QuotingSchema)` to create a new message.
 */
export declare const CsvSettings_QuotingSchema: GenMessage<CsvSettings_Quoting>;
/**
 * *
 * ArrowFormatSettings is settings for Ydb.ResultSet.Format.FORMAT_ARROW in Ydb.Query.ExecuteQueryRequest.
 * It is used to configure compression for record batches in Ydb.ResultSet.data field.
 *
 * @generated from message Ydb.Formats.ArrowFormatSettings
 */
export type ArrowFormatSettings = Message<"Ydb.Formats.ArrowFormatSettings"> & {
    /**
     * Codec for compressing binary data in Ydb.ResultSet.data field
     *
     * @generated from field: Ydb.Formats.ArrowFormatSettings.CompressionCodec compression_codec = 1;
     */
    compressionCodec?: ArrowFormatSettings_CompressionCodec;
};
/**
 * Describes the message Ydb.Formats.ArrowFormatSettings.
 * Use `create(ArrowFormatSettingsSchema)` to create a new message.
 */
export declare const ArrowFormatSettingsSchema: GenMessage<ArrowFormatSettings>;
/**
 * @generated from message Ydb.Formats.ArrowFormatSettings.CompressionCodec
 */
export type ArrowFormatSettings_CompressionCodec = Message<"Ydb.Formats.ArrowFormatSettings.CompressionCodec"> & {
    /**
     * Type of the compression codec
     *
     * @generated from field: Ydb.Formats.ArrowFormatSettings.CompressionCodec.Type type = 1;
     */
    type: ArrowFormatSettings_CompressionCodec_Type;
    /**
     * Compression level for the codec.
     * If is not specified, the default level of the codec type is used.
     *
     * @generated from field: optional int32 level = 2;
     */
    level?: number;
};
/**
 * Describes the message Ydb.Formats.ArrowFormatSettings.CompressionCodec.
 * Use `create(ArrowFormatSettings_CompressionCodecSchema)` to create a new message.
 */
export declare const ArrowFormatSettings_CompressionCodecSchema: GenMessage<ArrowFormatSettings_CompressionCodec>;
/**
 * @generated from enum Ydb.Formats.ArrowFormatSettings.CompressionCodec.Type
 */
export declare enum ArrowFormatSettings_CompressionCodec_Type {
    /**
     * Unspecified mode, corresponds to TYPE_NONE
     *
     * @generated from enum value: TYPE_UNSPECIFIED = 0;
     */
    UNSPECIFIED = 0,
    /**
     * Binary data without compression
     *
     * @generated from enum value: TYPE_NONE = 1;
     */
    NONE = 1,
    /**
     * Zstandard compression
     *
     * @generated from enum value: TYPE_ZSTD = 2;
     */
    ZSTD = 2,
    /**
     * LZ4 frame compression
     *
     * @generated from enum value: TYPE_LZ4_FRAME = 3;
     */
    LZ4_FRAME = 3
}
/**
 * Describes the enum Ydb.Formats.ArrowFormatSettings.CompressionCodec.Type.
 */
export declare const ArrowFormatSettings_CompressionCodec_TypeSchema: GenEnum<ArrowFormatSettings_CompressionCodec_Type>;
/**
 * *
 * ArrowFormatMeta is a metadata for Ydb.ResultSet.Format.FORMAT_ARROW in Ydb.ResultSet.
 * It is used to get the schema of the Arrow record batch.
 *
 * @generated from message Ydb.Formats.ArrowFormatMeta
 */
export type ArrowFormatMeta = Message<"Ydb.Formats.ArrowFormatMeta"> & {
    /**
     * Schema of the arrow batch of the result.
     * May be empty for custom Ydb.Query.SchemaInclusionMode
     *
     * @generated from field: bytes schema = 1;
     */
    schema: Uint8Array;
};
/**
 * Describes the message Ydb.Formats.ArrowFormatMeta.
 * Use `create(ArrowFormatMetaSchema)` to create a new message.
 */
export declare const ArrowFormatMetaSchema: GenMessage<ArrowFormatMeta>;
//# sourceMappingURL=ydb_formats_pb.d.ts.map