Experimental support for arrow result format
#1860
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| // 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.TODO() | ||
| 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;` | ||
|
|
||
| result, err := db.Query().QueryArrow(ctx, sql, query.WithIdempotent()) | ||
| if err != nil { | ||
| panic(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) | ||
| } | ||
| } | ||
|
|
||
| // 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"] | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,154 @@ | ||
| package query | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "context" | ||
| "io" | ||
|
|
||
| "github.com/ydb-platform/ydb-go-genproto/Ydb_Query_V1" | ||
| "github.com/ydb-platform/ydb-go-genproto/protos/Ydb" | ||
|
|
||
| "github.com/ydb-platform/ydb-go-sdk/v3/internal/query/arrow" | ||
| "github.com/ydb-platform/ydb-go-sdk/v3/internal/query/options" | ||
| "github.com/ydb-platform/ydb-go-sdk/v3/internal/xcontext" | ||
| "github.com/ydb-platform/ydb-go-sdk/v3/internal/xerrors" | ||
| "github.com/ydb-platform/ydb-go-sdk/v3/internal/xiter" | ||
| ) | ||
|
|
||
| type ( | ||
| arrowResult struct { | ||
| stream Ydb_Query_V1.QueryService_ExecuteQueryClient | ||
| resultSetIndex int64 | ||
| close context.CancelFunc | ||
| } | ||
|
|
||
| arrowPart struct { | ||
| resultSetIndex int64 | ||
| reader io.Reader | ||
| data []byte | ||
| } | ||
| ) | ||
|
|
||
| func (c *Client) QueryArrow(ctx context.Context, q string, opts ...options.Execute) (r arrow.Result, err error) { | ||
|
||
| ctx, cancel := xcontext.WithDone(ctx, c.done) | ||
| defer cancel() | ||
|
|
||
| r, err = arrowQuery(ctx, c.pool(), q, opts...) | ||
| if err != nil { | ||
| return nil, xerrors.WithStackTrace(err) | ||
| } | ||
|
|
||
| return r, nil | ||
| } | ||
|
|
||
| func arrowQuery(ctx context.Context, pool sessionPool, q string, opts ...options.Execute) ( | ||
| r arrow.Result, err error, | ||
| ) { | ||
| settings := options.ExecuteSettings(opts...) | ||
| err = do(ctx, pool, func(ctx context.Context, s *Session) (err error) { | ||
| r, err = s.executeArrow(ctx, q, options.ExecuteSettings(opts...)) | ||
| if err != nil { | ||
| return xerrors.WithStackTrace(err) | ||
| } | ||
|
|
||
| return nil | ||
| }, settings.RetryOpts()...) | ||
| if err != nil { | ||
| return nil, xerrors.WithStackTrace(err) | ||
| } | ||
|
|
||
| return r, nil | ||
| } | ||
|
|
||
| func (s *Session) executeArrow( | ||
|
||
| ctx context.Context, q string, settings executeSettings, | ||
| ) (_ arrow.Result, finalErr error) { | ||
| ctx, cancel := xcontext.WithDone(ctx, s.Done()) | ||
| defer func() { | ||
| if finalErr != nil { | ||
| cancel() | ||
| applyStatusByError(s, finalErr) | ||
| } | ||
| }() | ||
|
|
||
| request, callOptions, err := executeQueryRequest(s.ID(), q, settings) | ||
| if err != nil { | ||
| return nil, xerrors.WithStackTrace(err) | ||
| } | ||
|
|
||
| request.ResultSetFormat = Ydb.ResultSet_FORMAT_ARROW | ||
|
|
||
| executeCtx, executeCancel := xcontext.WithCancel(xcontext.ValueOnly(ctx)) | ||
| defer func() { | ||
| if finalErr != nil { | ||
| executeCancel() | ||
| } | ||
| }() | ||
|
|
||
| stream, err := s.client.ExecuteQuery(executeCtx, request, callOptions...) | ||
| if err != nil { | ||
| return nil, xerrors.WithStackTrace(err) | ||
| } | ||
|
|
||
| return &arrowResult{stream: stream, close: executeCancel}, nil | ||
| } | ||
|
|
||
| func (r *arrowResult) Parts(ctx context.Context) xiter.Seq2[arrow.Part, error] { | ||
| return func(yield func(arrow.Part, error) bool) { | ||
| for { | ||
| part, err := r.nextPart(ctx) | ||
| if err != nil { | ||
| if xerrors.Is(err, io.EOF) { | ||
| return | ||
| } | ||
| } | ||
| cont := yield(part, err) | ||
| if !cont || err != nil { | ||
| return | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func (r *arrowResult) nextPart(ctx context.Context) (arrow.Part, error) { | ||
| if ctx.Err() != nil { | ||
| return nil, xerrors.WithStackTrace(ctx.Err()) | ||
| } | ||
|
|
||
| part, err := r.stream.Recv() | ||
| if err != nil { | ||
| return nil, xerrors.WithStackTrace(err) | ||
| } | ||
|
|
||
| if part.GetResultSetIndex() <= 0 && r.resultSetIndex > 0 { | ||
| return nil, xerrors.WithStackTrace(io.EOF) | ||
| } | ||
| r.resultSetIndex = part.GetResultSetIndex() | ||
|
|
||
| schema := part.GetResultSet().GetArrowFormatMeta().GetSchema() | ||
|
|
||
| // Apache Arrow ipc.Reader expects schema and data to be concatenated | ||
| data := append(schema, part.GetResultSet().GetData()...) | ||
|
|
||
| rdr := bytes.NewReader(data) | ||
|
|
||
| return &arrowPart{reader: rdr, data: data, resultSetIndex: part.GetResultSetIndex()}, nil | ||
| } | ||
|
|
||
| func (r *arrowResult) Close(ctx context.Context) error { | ||
| r.close() | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func (p *arrowPart) Bytes() []byte { | ||
| return p.data | ||
| } | ||
|
|
||
| func (p *arrowPart) Read(buf []byte) (n int, err error) { | ||
| return p.reader.Read(buf) | ||
| } | ||
|
|
||
| func (p *arrowPart) GetResultSetIndex() int64 { | ||
| return p.resultSetIndex | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| package arrow | ||
|
|
||
| import ( | ||
| "context" | ||
| "io" | ||
|
|
||
| "github.com/ydb-platform/ydb-go-sdk/v3/internal/closer" | ||
| "github.com/ydb-platform/ydb-go-sdk/v3/internal/xiter" | ||
| ) | ||
|
|
||
| type ( | ||
| Result interface { | ||
| closer.Closer | ||
|
|
||
| // Parts is the range iterator for result parts (parts implement [io.Reader]) | ||
| Parts(ctx context.Context) xiter.Seq2[Part, error] | ||
| } | ||
| Part interface { | ||
| io.Reader | ||
|
|
||
| // Bytes returns part as bytes | ||
| Bytes() []byte | ||
|
|
||
| // GetResultSetIndex returns result set index | ||
| GetResultSetIndex() int64 | ||
| } | ||
| ) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
todo -> background