Added support for binary decoding

Author: ankane

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.1.1 (unreleased)
+
+- Added support for binary decoding
+
 ## 0.1.0 (2025-06-07)
 
 - First release

src/halfvec.jl

@@ -1,8 +1,31 @@
+using LibPQ
+
 struct HalfVector
     vec::Base.Vector{Float16}
 end
 
-function Base.parse(::Type{HalfVector}, s::String)
+function Base.parse(::Type{HalfVector}, pqv::LibPQ.PQBinaryValue{OID}) where {OID}
+    ptr = LibPQ.data_pointer(pqv)
+
+    dim = ntoh(unsafe_load(Ptr{Int16}(ptr)))
+    ptr += sizeof(Int16)
+
+    # TODO check unused
+    unused = ntoh(unsafe_load(Ptr{Int16}(ptr)))
+    ptr += sizeof(Int16)
+
+    vec = []
+    for i = 1:dim
+        v = ntoh(unsafe_load(Ptr{Float16}(ptr)))
+        ptr += sizeof(Float16)
+        append!(vec, v)
+    end
+
+    HalfVector(vec)
+end
+
+function Base.parse(::Type{HalfVector}, pqv::LibPQ.PQTextValue{OID}) where {OID}
+    s = unsafe_string(pqv)
     HalfVector(map(x -> Base.parse(Float16, x), split(s[2:end-1], ",")))
 end
 

src/sparsevec.jl

@@ -1,10 +1,41 @@
-using SparseArrays
+using LibPQ, SparseArrays
 
 struct SparseVector
     vec::SparseArrays.SparseVector{Float32,Int32}
 end
 
-function Base.parse(::Type{SparseVector}, s::String)
+function Base.parse(::Type{SparseVector}, pqv::LibPQ.PQBinaryValue{OID}) where {OID}
+    ptr = LibPQ.data_pointer(pqv)
+
+    dim = ntoh(unsafe_load(Ptr{Int32}(ptr)))
+    ptr += sizeof(Int32)
+
+    nnz = ntoh(unsafe_load(Ptr{Int32}(ptr)))
+    ptr += sizeof(Int32)
+
+    # TODO check unused
+    unused = ntoh(unsafe_load(Ptr{Int32}(ptr)))
+    ptr += sizeof(Int32)
+
+    indices = []
+    for i = 1:nnz
+        v = ntoh(unsafe_load(Ptr{Int32}(ptr)))
+        ptr += sizeof(Int32)
+        append!(indices, v + 1)
+    end
+
+    values = []
+    for i = 1:nnz
+        v = ntoh(unsafe_load(Ptr{Float32}(ptr)))
+        ptr += sizeof(Float32)
+        append!(values, v)
+    end
+
+    SparseVector(sparsevec(indices, values, dim))
+end
+
+function Base.parse(::Type{SparseVector}, pqv::LibPQ.PQTextValue{OID}) where {OID}
+    s = unsafe_string(pqv)
     elements, dim = rsplit(s, "/"; limit=2)
     elements = map(e -> split(e, ":"; limit=2), split(elements[2:end-1], ","))
     indices = map(v -> Base.parse(Int32, v[1]), elements)

src/vector.jl

@@ -1,8 +1,31 @@
+using LibPQ
+
 struct Vector
     vec::Base.Vector{Float32}
 end
 
-function Base.parse(::Type{Vector}, s::String)
+function Base.parse(::Type{Vector}, pqv::LibPQ.PQBinaryValue{OID}) where {OID}
+    ptr = LibPQ.data_pointer(pqv)
+
+    dim = ntoh(unsafe_load(Ptr{Int16}(ptr)))
+    ptr += sizeof(Int16)
+
+    # TODO check unused
+    unused = ntoh(unsafe_load(Ptr{Int16}(ptr)))
+    ptr += sizeof(Int16)
+
+    vec = []
+    for i = 1:dim
+        v = ntoh(unsafe_load(Ptr{Float32}(ptr)))
+        ptr += sizeof(Float32)
+        append!(vec, v)
+    end
+
+    Vector(vec)
+end
+
+function Base.parse(::Type{Vector}, pqv::LibPQ.PQTextValue{OID}) where {OID}
+    s = unsafe_string(pqv)
     Vector(map(x -> Base.parse(Float32, x), split(s[2:end-1], ",")))
 end
 

test/runtests.jl

@@ -10,6 +10,9 @@ Pgvector.register!(conn)
 
     vec = columntable(execute(conn, "SELECT '[1,2,3]'::vector"))[1][1]
     @test vec.vec == [1, 2, 3]
+
+    vec = columntable(execute(conn, "SELECT '[1,2,3]'::vector", binary_format=true))[1][1]
+    @test vec.vec == [1, 2, 3]
 end
 
 @testset "HalfVector" begin
@@ -18,6 +21,9 @@ end
 
     vec = columntable(execute(conn, "SELECT '[1,2,3]'::halfvec"))[1][1]
     @test vec.vec == [1, 2, 3]
+
+    vec = columntable(execute(conn, "SELECT '[1,2,3]'::halfvec", binary_format=true))[1][1]
+    @test vec.vec == [1, 2, 3]
 end
 
 @testset "SparseVector" begin
@@ -26,4 +32,7 @@ end
 
     vec = columntable(execute(conn, "SELECT '{1:1,3:2,5:3}/6'::sparsevec"))[1][1]
     @test vec.vec == sparsevec([1, 0, 2, 0, 3, 0])
+
+    vec = columntable(execute(conn, "SELECT '{1:1,3:2,5:3}/6'::sparsevec", binary_format=true))[1][1]
+    @test vec.vec == sparsevec([1, 0, 2, 0, 3, 0])
 end