README
¶
substrait-go
Experimental Go bindings for substrait
Note:
This is work in progress still, things still to do:
- Expression parsing
- Reading in extension yamls
- CI building and testing the implementation
- Serialization/Deserialization of some expression types:
- IfThen
- SwitchExpression
- SingularOrList
- MultiOrList
- Cast
- Nested
- Subquery
- Serialization/Deserialization of Plan and Relations
- Plan
- PlanRel
- Rel
- ReadRel
- FilterRel
- FetchRel
- AggregateRel
- SortRel
- JoinRel
- ProjectRel
- SetRel
- ExtensionSingleRel
- ExtensionMultiRel
- ExtensionLeafRel
- CrossRel
- HashJoinRel
- MergeJoinRel
- DdlRel
- WriteRel
- ExchangeRel
- Plan Building helpers
- ReadRel
- NamedScanReadRel
- VirtualTableReadRel
- ExtensionTableReadRel
- LocalFileReadRel
- FilterRel
- FetchRel
- AggregateRel
- SortRel
- JoinRel
- ProjectRel
- SetRel
- CrossRel
- HashJoinRel
- MergeJoinRel
- DdlRel
- WriteRel
- ExchangeRel
- ReadRel
As this is built out, you can expect refactors and other changes to the structure of the package for the time being. The API should not yet be considered stable.
Generate from proto files
Install buf
First ensure you have buf installed by following https://docs.buf.build/installation.
Install go plugin
Run the following to install the Go plugin for protobuf:
$ go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
Ensure that your GOPATH is on your path:
$ export PATH="$PATH:$(go env GOPATH)/bin"
Run go generate
As long as buf and the Go protobuf plugin are installed, you can
simply run go generate to generate the updated .pb.go files. It
will generate them by referencing the primary substrait-io repository.
You can then commit the updated files.
Documentation
¶
Overview ¶
Package substraitgo contains the experimental go bindings for substrait (https://substrait.io).
Current generated proto substrait version: v0.29.0
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( ErrNotImplemented = errors.New("not implemented") ErrInvalidType = errors.New("invalid type") ErrInvalidExpr = errors.New("invalid expression") ErrNotFound = errors.New("not found") ErrKeyExists = errors.New("key already exists") ErrInvalidRel = errors.New("invalid relation") ErrInvalidArg = errors.New("invalid argument") )
Functions ¶
This section is empty.
Types ¶
This section is empty.
Source Files
Directories