protoc-gen-go-opensearch

README

protoc-gen-go-opensearch

Plugin used to generate mappings for OpenSearch indexes based on protojson. WIP

TODO

[ ] A way to generate mappings for external protos [ ] Add options to match options from protojson

It is highly based of the code of protoc-gen-go. I just got the code, stripped out any unnecessary parts, and built this plugin.

Usage

Install it using the go install command:

go install github.com/Hellysonrp/protoc-gen-go-opensearch

Some usage examples:

protoc --plugin protoc-gen-go-opensearch --go-opensearch_out=output example.proto

protoc --plugin protoc-gen-go-opensearch --go-opensearch_out=paths=source_relative:output example.proto

If you have problems with protoc not finding the plugin in the PATH, I recommend passing the absolute path to the plugin:

protoc --plugin ${HOME}/go/bin/protoc-gen-go-opensearch --go-opensearch_out=output example.proto

protoc --plugin ${HOME}/go/bin/protoc-gen-go-opensearch --go-opensearch_out=paths=source_relative:output example.proto

Then you can use it to get the mappings to send to OpenSearch:

mappings := types.OpensearchMapping{
    Properties: (&Example{}).GetOpensearchMappings(),
}

b, err := json.Marshal(mappings)
if err != nil {
    panic(err)
}

...

// this is only an example
// you may want to get the response and error
opensearchapi.IndicesCreateRequest{
    Index: index,
    Body: strings.NewReader(fmt.Sprintf(`
        {
            "mappings": %s
        }
    `, string(b))),
}.Do(ctx, client)

Documentation

Overview

The protoc-gen-go-opensearch binary is a protoc plugin to generate Go code for both proto2 and proto3 versions of the protocol buffer language.