Vector Storage

Overview

With the explosive growth of AI scenarios, vector storage has become increasingly important. Paimon provides optimized storage solutions specifically designed for vector data.

Paimon stores vector columns in dedicated files using the Vortex columnar format, which is optimized for vector workloads with high compression ratio and fast scan performance.

Vector Data Type

Paimon supports defining columns of type VECTOR<t, n>, which represents a fixed-length, dense vector column, where:

• t: The element type. Supports: BOOLEAN, TINYINT, SMALLINT, INT, BIGINT, FLOAT, DOUBLE;
• n: The vector dimension, must be a positive integer not exceeding 2,147,483,647.

Compared to variable-length arrays, dense vectors provide:

• More natural semantic constraints, preventing mismatched lengths and null elements at the storage layer;
• Better point-lookup performance, eliminating offset array storage and access;
• Closer alignment with type representations in specialized vector engines, avoiding memory copies and type conversions.

Notes:

• Columns of VECTOR type cannot be used as primary key columns, partition columns, or for sorting.
• If a VECTOR value itself is not null, its elements are not allowed to be null.

Dedicated Vector File Storage

Paimon stores vector columns in separate .vector.vortex files within Data Evolution tables, keeping scalar and vector data independently optimized.

File layout:

table/
├── bucket-0/
│   ├── data-uuid-0.parquet       # Scalar columns (id, name, ...)
│   ├── data-uuid-1.blob          # Blob data
│   ├── data-uuid-2.vector.vortex # Vector columns in Vortex format
│   └── ...
├── manifest/
├── schema/
└── snapshot/

Option	Description
vector.file.format	File format for dedicated vector files. Set to vortex to enable dedicated vector storage.
vector.target-file-size	Target file size for vector files. Defaults to 10 * 'target-file-size'.
row-tracking.enabled	Must be true for dedicated vector storage.
data-evolution.enabled	Must be true for dedicated vector storage.

Create Table

The recommended way to create a vector table in SQL is to use the comment directive __VECTOR_FIELD;dim on the column. Paimon automatically converts the ARRAY type to VECTOR and registers the field in the vector-field option.

Flink SQL

-- Comment directive: __VECTOR_FIELD;{dim}; optional comment
CREATE TABLE vector_table (
    id BIGINT,
    embed ARRAY<FLOAT> COMMENT '__VECTOR_FIELD;128; product embedding'
) WITH (
    'vector.file.format' = 'vortex',
    'row-tracking.enabled' = 'true',
    'data-evolution.enabled' = 'true'
);

-- Multiple vector columns
CREATE TABLE multi_vector_table (
    id BIGINT,
    embed1 ARRAY<FLOAT> COMMENT '__VECTOR_FIELD;128',
    embed2 ARRAY<FLOAT> COMMENT '__VECTOR_FIELD;768'
) WITH (
    'vector.file.format' = 'vortex',
    'row-tracking.enabled' = 'true',
    'data-evolution.enabled' = 'true'
);

Spark SQL

CREATE TABLE vector_table (
    id BIGINT,
    embed ARRAY<FLOAT> COMMENT '__VECTOR_FIELD;128; product embedding'
) TBLPROPERTIES (
    'vector.file.format' = 'vortex',
    'row-tracking.enabled' = 'true',
    'data-evolution.enabled' = 'true'
);

Java API

// Java API uses VectorType directly — no comment directive needed
Schema schema = Schema.newBuilder()
        .column("id", DataTypes.BIGINT())
        .column("embed", DataTypes.VECTOR(128, DataTypes.FLOAT()))
        .option("vector.file.format", "vortex")
        .option("row-tracking.enabled", "true")
        .option("data-evolution.enabled", "true")
        .option("bucket", "-1")
        .build();

Python API

import pyarrow as pa
from pypaimon import Schema

# Fixed-size list is automatically recognized as VECTOR type
pa_schema = pa.schema([
    ('id', pa.int64()),
    ('embed', pa.list_(pa.float32(), 128)),
])

schema = Schema.from_pyarrow_schema(
    pa_schema,
    options={
        'vector.file.format': 'vortex',
        'row-tracking.enabled': 'true',
        'data-evolution.enabled': 'true',
        'bucket': '-1',
    }
)

Adding a Vector Column

Flink SQL

ALTER TABLE vector_table
    ADD embed2 ARRAY<FLOAT> COMMENT '__VECTOR_FIELD;768; text embedding';

Spark SQL

ALTER TABLE vector_table
    ADD COLUMN embed2 ARRAY<FLOAT> COMMENT '__VECTOR_FIELD;768; text embedding';

Java API

// Java API: add column with VectorType directly
schemaManager.commitChanges(
    SchemaChange.addColumn("embed2", DataTypes.VECTOR(768, DataTypes.FLOAT())));

// Or use comment directive like SQL
schemaManager.commitChanges(
    SchemaChange.addColumn("embed2", DataTypes.ARRAY(DataTypes.FLOAT()),
        "__VECTOR_FIELD;768; text embedding", null));

Python API

catalog.alter_table(
    'default.vector_table',
    [('add', 'embed2', pa.list_(pa.float32(), 768))]
)

Write Data

Flink SQL

INSERT INTO vector_table VALUES (1, ARRAY[1.0, 2.0, 3.0, ...]);

Spark SQL

INSERT INTO vector_table VALUES (1, ARRAY(1.0, 2.0, 3.0, ...));

Java API

BatchWriteBuilder builder = table.newBatchWriteBuilder();
try (BatchTableWrite write = builder.newWrite();
        BatchTableCommit commit = builder.newCommit()) {
    InternalVector vector = BinaryVector.fromPrimitiveArray(new float[] {1.0f, 2.0f, 3.0f});
    write.write(GenericRow.of(1L, vector));
    commit.commit(write.prepareCommit());
}

Python API

import pyarrow as pa

data = pa.table({
    'id': pa.array([1, 2, 3], type=pa.int64()),
    'embed': pa.FixedSizeListArray.from_arrays(
        pa.array([1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0], type=pa.float32()),
        3  # dimension
    ),
})

write_builder = table.new_batch_write_builder()
writer = write_builder.new_write()
writer.write_arrow(data)
commit_messages = writer.prepare_commit()
write_builder.new_commit().commit(commit_messages)
writer.close()

Read Data

Flink SQL

SELECT id, embed FROM vector_table;

Spark SQL

SELECT id, embed FROM vector_table;

Java API

ReadBuilder readBuilder = table.newReadBuilder();
TableScan.Plan plan = readBuilder.newScan().plan();
try (RecordReader<InternalRow> reader = readBuilder.newRead().createReader(plan)) {
    reader.forEachRemaining(row -> {
        long id = row.getLong(0);
        float[] vector = row.getVector(1).toFloatArray();
        System.out.println(id + ": " + Arrays.toString(vector));
    });
}

Python API

read_builder = table.new_read_builder()
splits = read_builder.new_scan().plan().splits()
result = read_builder.new_read().to_arrow(splits)

print(result.column('embed').to_pylist())
# [[1.0, 2.0, 3.0], [4.0, 5.0, 6.0], [7.0, 8.0, 9.0]]