protoc-gen-go-firestore

README

protoc-gen-go-firestore

Exploration into generating Firestore bindings for Go from your .proto files.

Example

We generate a convenient API to read/write your protos from/to Firestore:

package main

import (
	"context"

	"cloud.google.com/go/firestore"
	servicev1 "github.com/myorg/apis-go/pkg/my/service/v1"
)

func main() {
	servicev1.Firestore(client()).
		Accounts().
		Doc("myid").
		Set(context.Background(), &servicev1.Account{
			Name: "myaccount",
		})
}

func client() *firestore.Client {
	c, err := firestore.NewClient(context.Background(), "project")
	if err != nil {
		panic(err)
	}
	return c
}

Given:

syntax = "proto3";
package my.service.v1;

import "firestore/options.proto";

option go_package = "github.com/myorg/apis-go/pkg/my/service/v1;servicev1";

message Account {
  option (firestore.message).collection = "accounts/{id}";
  string name = 1;
}

message User {
  option (firestore.message).collection = "accounts/{id}/users/{id}";
  string name = 1;
}