Experimental support for arrow result format

CHANGELOG.md

@@ -1,3 +1,4 @@
+* Added experimental support for query results in `Apache Arrow`
 * Fix flaky unit test TestUnboundedChanContextTimeout
 
 ## v3.115.7

examples/apache_arrow/main.go

@@ -0,0 +1,86 @@
+// This example shows how you can get results in Apache Arrow format.
+//
+// Before starting add apache arrow IPC package:
+//
+//	go get github.com/apache/arrow/go/arrow
+//
+// Currently (2025-09-11), Apache Arrow supported in the `main` YDB branch and
+// enabled by feature flag `EnableArrowResultSetFormat`.
+package main
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/apache/arrow/go/arrow/ipc"
+	"github.com/ydb-platform/ydb-go-sdk/v3"
+	"github.com/ydb-platform/ydb-go-sdk/v3/query"
+)
+
+func main() {
+	ctx := context.Background()
+	db, err := ydb.Open(ctx, "grpc://localhost:2136/local")
+	if err != nil {
+		panic(err)
+	}
+	defer db.Close(ctx) // cleanup resources
+
+	sql := `SELECT 42 as id, "my string" as myStr;
+SELECT 24 as id, "WOW" as myStr, "UHH" as secondStr;`
+
+	err = db.Query().Do(ctx, func(ctx context.Context, s query.Session) error {
+		result, err := s.QueryArrow(ctx, sql)
+		if err != nil {
+			return err
+		}
+		defer result.Close(ctx)
+
+		for part, err := range result.Parts(ctx) {
+			if err != nil {
+				panic(err)
+			}
+
+			fmt.Printf("ResultSet#%d ", part.GetResultSetIndex())
+
+			// or you can use `part.Bytes()` instead of [io.Reader] interface
+
+			rdr, err := ipc.NewReader(part) // part already implements io.Reader
+			if err != nil {
+				panic(err)
+			}
+
+			for rdr.Next() {
+				out := rdr.Record()
+				fmt.Println(out)
+			}
+		}
+
+		return nil
+	}, query.WithIdempotent())
+	if err != nil {
+		panic(err)
+	}
+
+	// Output:
+	// ResultSet#0 record:
+	//
+	//	schema:
+	//	fields: 2
+	//	  - id: type=int32
+	//	  - myStr: type=binary
+	//	rows: 1
+	//	col[0][id]: [42]
+	//	col[1][myStr]: ["my string"]
+	//
+	// ResultSet#1 record:
+	//
+	//	schema:
+	//	fields: 3
+	//	  - id: type=int32
+	//	  - myStr: type=binary
+	//	  - secondStr: type=binary
+	//	rows: 1
+	//	col[0][id]: [24]
+	//	col[1][myStr]: ["WOW"]
+	//	col[2][secondStr]: ["UHH"]
+}

examples/go.mod

@@ -5,6 +5,7 @@ go 1.23.0
 toolchain go1.23.6
 
 require (
+	github.com/apache/arrow/go/arrow v0.0.0-20211112161151-bc219186db40
 	github.com/golang-jwt/jwt/v4 v4.5.2
 	github.com/google/uuid v1.6.0
 	github.com/gorilla/mux v1.8.0
@@ -34,6 +35,7 @@ require (
 	github.com/goccy/go-json v0.10.3 // indirect
 	github.com/golang/protobuf v1.5.4 // indirect
 	github.com/golang/snappy v0.0.4 // indirect
+	github.com/google/flatbuffers v23.5.26+incompatible // indirect
 	github.com/hashicorp/golang-lru/v2 v2.0.7 // indirect
 	github.com/jackc/pgpassfile v1.0.0 // indirect
 	github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 // indirect
@@ -43,27 +45,30 @@ require (
 	github.com/jinzhu/now v1.1.5 // indirect
 	github.com/jonboulle/clockwork v0.5.0 // indirect
 	github.com/json-iterator/go v1.1.12 // indirect
+	github.com/klauspost/compress v1.17.7 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect
 	github.com/mattn/go-sqlite3 v1.14.16 // indirect
 	github.com/mfridman/interpolate v0.0.2 // indirect
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
 	github.com/ncruces/go-strftime v0.1.9 // indirect
+	github.com/pierrec/lz4/v4 v4.1.21 // indirect
 	github.com/prometheus/client_model v0.6.0 // indirect
 	github.com/prometheus/common v0.53.0 // indirect
 	github.com/prometheus/procfs v0.14.0 // indirect
 	github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec // indirect
 	github.com/sethvargo/go-retry v0.3.0 // indirect
 	github.com/syndtr/goleveldb v1.0.0 // indirect
 	github.com/yandex-cloud/go-genproto v0.0.0-20220815090733-4c139c0154e2 // indirect
-	github.com/ydb-platform/ydb-go-genproto v0.0.0-20241112172322-ea1f63298f77 // indirect
+	github.com/ydb-platform/ydb-go-genproto v0.0.0-20250911135631-b3beddd517d9 // indirect
 	github.com/ydb-platform/ydb-go-yc-metadata v0.6.1 // indirect
 	go.uber.org/multierr v1.11.0 // indirect
 	golang.org/x/crypto v0.36.0 // indirect
 	golang.org/x/net v0.38.0 // indirect
 	golang.org/x/sys v0.31.0 // indirect
 	golang.org/x/text v0.23.0 // indirect
 	golang.org/x/tools v0.24.0 // indirect
+	golang.org/x/xerrors v0.0.0-20231012003039-104605ab7028 // indirect
 	google.golang.org/genproto/googleapis/api v0.0.0-20241015192408-796eee8c2d53 // indirect
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20241015192408-796eee8c2d53 // indirect
 	google.golang.org/grpc v1.69.4 // indirect