Interface GeoArrowSerializationOptionsExperimental

Bounds and migration policy for dependency-free persisted GeoArrow batches.

interface GeoArrowSerializationOptions {
    maxBackingBytes?: number;
    maxBufferViews?: number;
    maxCopiedBytes?: number;
    maxDictionaryValues?: number;
    maxMetadataEntries?: number;
    maxRings?: number;
    maxRows?: number;
    maxSchemaNodes?: number;
    maxSerializedBytes?: number;
    maxStringBytes?: number;
    maxVertices?: number;
    migrations?: readonly GeoArrowEnvelopeMigrationV1[];
}

Hierarchy (view full)

Properties

maxBackingBytes?: number

Counts complete unique backing buffers, not only referenced slices.

maxBufferViews?: number

Maximum number of buffer descriptors, including zero-byte/shared views.

maxCopiedBytes?: number

Exact ceiling for newly allocated payload buffers.

maxDictionaryValues?: number
maxMetadataEntries?: number

Maximum combined schema, field, and type-parameter entries.

maxRings?: number
maxRows?: number
maxSchemaNodes?: number

Maximum total top-level and nested schema fields.

maxSerializedBytes?: number

Maximum UTF-8 envelope size accepted or produced.

maxStringBytes?: number

Maximum UTF-8 bytes across descriptor identifiers, keys, and string values.

maxVertices?: number
migrations?: readonly GeoArrowEnvelopeMigrationV1[]

Replaces the shipped ladder for this read. Steps still receive only the parsed envelope, so an injected ladder cannot widen the bounds above.