Rename v25 APIs to v2 APIs (#256)

Author: mangalaman93

.trunk/trunk.yaml

@@ -25,7 +25,7 @@ lint:
     - linters: [ALL]
       paths:
         - protos/api/*.pb.go
-        - protos/api.v25/*.pb.go
+        - protos/api.v2/*.pb.go
   enabled:
     - [email protected]
     - [email protected]

README.md

@@ -14,7 +14,7 @@ repository.**
 ## Table of contents
 
 - [Supported Versions](#supported-versions)
-- [v25 APIs](#v25-apis)
+- [v2 APIs](#v2-apis)
   - [Connection Strings](#connection-strings)
   - [Advanced Client Creation](#advanced-client-creation)
   - [Connecting To Dgraph Cloud](#connecting-to-dgraph-cloud)
@@ -59,7 +59,7 @@ version of this client and their corresponding import paths.
 | dgraph 25.X.Y  | dgo 240.X.Y | "github.com/dgraph-io/dgo/v240" |
 | dgraph 25.X.Y  | dgo 250.X.Y | "github.com/dgraph-io/dgo/v250" |
 
-## v25 APIs
+## v2 APIs
 
 These are _experimental_ APIs that we are still making changes to. If you have any feedback, please
 let us know either on Discord or GitHub.
@@ -276,7 +276,7 @@ queryDQL := `{
     age
   }
 }`
-resp, err = client.RunDQL(context.TODO(), dgo.RootNamespace, queryDQL, dgo.WithResponseFormat(api_v25.RespFormat_RDF))
+resp, err = client.RunDQL(context.TODO(), dgo.RootNamespace, queryDQL, dgo.WithResponseFormat(api_v2.RespFormat_RDF))
 // Handle error
 fmt.Printf("%s\n", resp.QueryResult)
 ```

alter_v25.go renamed to alterv2.go

@@ -8,59 +8,59 @@ package dgo
 import (
 	"context"
 
-	apiv25 "github.com/dgraph-io/dgo/v250/protos/api.v25"
+	apiv2 "github.com/dgraph-io/dgo/v250/protos/api.v2"
 )
 
 func (d *Dgraph) DropAllNamespaces(ctx context.Context) error {
-	req := &apiv25.AlterRequest{Op: apiv25.AlterOp_DROP_ALL}
+	req := &apiv2.AlterRequest{Op: apiv2.AlterOp_DROP_ALL}
 	return d.doAlter(ctx, req)
 }
 
 func (d *Dgraph) DropAll(ctx context.Context, nsName string) error {
-	req := &apiv25.AlterRequest{
-		Op:     apiv25.AlterOp_DROP_ALL_IN_NS,
+	req := &apiv2.AlterRequest{
+		Op:     apiv2.AlterOp_DROP_ALL_IN_NS,
 		NsName: nsName,
 	}
 	return d.doAlter(ctx, req)
 }
 
 func (d *Dgraph) DropData(ctx context.Context, nsName string) error {
-	req := &apiv25.AlterRequest{
-		Op:     apiv25.AlterOp_DROP_DATA_IN_NS,
+	req := &apiv2.AlterRequest{
+		Op:     apiv2.AlterOp_DROP_DATA_IN_NS,
 		NsName: nsName,
 	}
 	return d.doAlter(ctx, req)
 }
 
 func (d *Dgraph) DropPredicate(ctx context.Context, nsName, predicate string) error {
-	req := &apiv25.AlterRequest{
-		Op:              apiv25.AlterOp_DROP_PREDICATE_IN_NS,
+	req := &apiv2.AlterRequest{
+		Op:              apiv2.AlterOp_DROP_PREDICATE_IN_NS,
 		NsName:          nsName,
 		PredicateToDrop: predicate,
 	}
 	return d.doAlter(ctx, req)
 }
 
 func (d *Dgraph) DropType(ctx context.Context, nsName, typeName string) error {
-	req := &apiv25.AlterRequest{
-		Op:         apiv25.AlterOp_DROP_TYPE_IN_NS,
+	req := &apiv2.AlterRequest{
+		Op:         apiv2.AlterOp_DROP_TYPE_IN_NS,
 		NsName:     nsName,
 		TypeToDrop: typeName,
 	}
 	return d.doAlter(ctx, req)
 }
 
 func (d *Dgraph) SetSchema(ctx context.Context, nsName string, schema string) error {
-	req := &apiv25.AlterRequest{
-		Op:     apiv25.AlterOp_SCHEMA_IN_NS,
+	req := &apiv2.AlterRequest{
+		Op:     apiv2.AlterOp_SCHEMA_IN_NS,
 		NsName: nsName,
 		Schema: schema,
 	}
 	return d.doAlter(ctx, req)
 }
 
-func (d *Dgraph) doAlter(ctx context.Context, req *apiv25.AlterRequest) error {
-	_, err := doWithRetryLogin(ctx, d, func(dc apiv25.DgraphClient) (*apiv25.AlterResponse, error) {
+func (d *Dgraph) doAlter(ctx context.Context, req *apiv2.AlterRequest) error {
+	_, err := doWithRetryLogin(ctx, d, func(dc apiv2.DgraphClient) (*apiv2.AlterResponse, error) {
 		return dc.Alter(d.getContext(ctx), req)
 	})
 	return err

client.go

@@ -23,7 +23,7 @@ import (
 	"google.golang.org/protobuf/proto"
 
 	"github.com/dgraph-io/dgo/v250/protos/api"
-	apiv25 "github.com/dgraph-io/dgo/v250/protos/api.v25"
+	apiv2 "github.com/dgraph-io/dgo/v250/protos/api.v2"
 )
 
 const (
@@ -40,7 +40,7 @@ type Dgraph struct {
 
 	conns []*grpc.ClientConn
 	dc    []api.DgraphClient
-	dcv25 []apiv25.DgraphClient
+	dcv2  []apiv2.DgraphClient
 }
 
 type authCreds struct {
@@ -65,12 +65,12 @@ func (a *authCreds) RequireTransportSecurity() bool {
 //
 // Deprecated: Use dgo.NewClient or dgo.Open instead.
 func NewDgraphClient(clients ...api.DgraphClient) *Dgraph {
-	dcv25 := make([]apiv25.DgraphClient, len(clients))
+	dcv2 := make([]apiv2.DgraphClient, len(clients))
 	for i, client := range clients {
-		dcv25[i] = apiv25.NewDgraphClient(api.GetConn(client))
+		dcv2[i] = apiv2.NewDgraphClient(api.GetConn(client))
 	}
 
-	d := &Dgraph{useV1: true, dc: clients, dcv25: dcv25}
+	d := &Dgraph{useV1: true, dc: clients, dcv2: dcv2}
 
 	// we ignore the error here, because there is not much we can do about
 	// the error. We want to make best effort to figure out what API to use.

client_v25.go renamed to clientv2.go

@@ -21,7 +21,7 @@ import (
 	"google.golang.org/grpc/status"
 
 	"github.com/dgraph-io/dgo/v250/protos/api"
-	apiv25 "github.com/dgraph-io/dgo/v250/protos/api.v25"
+	apiv2 "github.com/dgraph-io/dgo/v250/protos/api.v2"
 )
 
 const (
@@ -107,7 +107,7 @@ func WithACLCreds(username, password string) ClientOption {
 
 // WithResponseFormat sets the response format for queries. By default, the
 // response format is JSON. We can also specify RDF format.
-func WithResponseFormat(respFormat apiv25.RespFormat) TxnOption {
+func WithResponseFormat(respFormat apiv2.RespFormat) TxnOption {
 	return func(o *txnOptions) error {
 		o.respFormat = respFormat
 		return nil
@@ -219,18 +219,18 @@ func NewRoundRobinClient(endpoints []string, opts ...ClientOption) (*Dgraph, err
 
 	conns := make([]*grpc.ClientConn, len(endpoints))
 	dc := make([]api.DgraphClient, len(endpoints))
-	dcv25 := make([]apiv25.DgraphClient, len(endpoints))
+	dcv2 := make([]apiv2.DgraphClient, len(endpoints))
 	for i, endpoint := range endpoints {
 		conn, err := grpc.NewClient(endpoint, co.gopts...)
 		if err != nil {
 			return nil, fmt.Errorf("failed to connect to endpoint [%s]: %w", endpoint, err)
 		}
 		conns[i] = conn
 		dc[i] = api.NewDgraphClient(conn)
-		dcv25[i] = apiv25.NewDgraphClient(conn)
+		dcv2[i] = apiv2.NewDgraphClient(conn)
 	}
 
-	d := &Dgraph{dc: dc, dcv25: dcv25}
+	d := &Dgraph{dc: dc, dcv2: dcv2}
 	if err := d.ping(); err != nil {
 		d.Close()
 		return nil, err
@@ -265,8 +265,8 @@ func (d *Dgraph) signInUser(ctx context.Context, username, password string) erro
 	d.jwtMutex.Lock()
 	defer d.jwtMutex.Unlock()
 
-	dc := d.anyClientv25()
-	req := &apiv25.SignInUserRequest{UserId: username, Password: password}
+	dc := d.anyClientv2()
+	req := &apiv2.SignInUserRequest{UserId: username, Password: password}
 	resp, err := dc.SignInUser(ctx, req)
 	if err != nil {
 		return err
@@ -284,7 +284,7 @@ func (d *Dgraph) ping() error {
 	// By default, we assume the server is using v1 API
 	d.useV1 = true
 
-	if _, err := d.dcv25[0].Ping(ctx, nil); err != nil {
+	if _, err := d.dcv2[0].Ping(ctx, nil); err != nil {
 		if status.Code(err) != codes.Unimplemented {
 			return fmt.Errorf("error pinging the database: %v", err)
 		}

client_v25_test.go renamed to clientv2_test.go

@@ -10,7 +10,7 @@ import (
 	"errors"
 	"math/rand"
 
-	apiv25 "github.com/dgraph-io/dgo/v250/protos/api.v25"
+	apiv2 "github.com/dgraph-io/dgo/v250/protos/api.v2"
 )
 
 const (
@@ -24,7 +24,7 @@ var (
 type txnOptions struct {
 	readOnly   bool
 	bestEffort bool
-	respFormat apiv25.RespFormat
+	respFormat apiv2.RespFormat
 }
 
 // TxnOption is a function that modifies the txn options.
@@ -64,58 +64,58 @@ func buildTxnOptions(opts ...TxnOption) (*txnOptions, error) {
 // RunDQL runs a DQL query in the given namespace. A DQL query could be a mutation
 // or a query or an upsert which is a combination of mutations and queries.
 func (d *Dgraph) RunDQL(ctx context.Context, nsName string, q string, opts ...TxnOption) (
-	*apiv25.RunDQLResponse, error) {
+	*apiv2.RunDQLResponse, error) {
 
 	return d.RunDQLWithVars(ctx, nsName, q, nil, opts...)
 }
 
 // RunDQLWithVars is like RunDQL with variables.
 func (d *Dgraph) RunDQLWithVars(ctx context.Context, nsName string, q string,
-	vars map[string]string, opts ...TxnOption) (*apiv25.RunDQLResponse, error) {
+	vars map[string]string, opts ...TxnOption) (*apiv2.RunDQLResponse, error) {
 
 	topts, err := buildTxnOptions(opts...)
 	if err != nil {
 		return nil, err
 	}
 
-	req := &apiv25.RunDQLRequest{NsName: nsName, DqlQuery: q, Vars: vars,
+	req := &apiv2.RunDQLRequest{NsName: nsName, DqlQuery: q, Vars: vars,
 		ReadOnly: topts.readOnly, BestEffort: topts.bestEffort, RespFormat: topts.respFormat}
-	return doWithRetryLogin(ctx, d, func(dc apiv25.DgraphClient) (*apiv25.RunDQLResponse, error) {
+	return doWithRetryLogin(ctx, d, func(dc apiv2.DgraphClient) (*apiv2.RunDQLResponse, error) {
 		return dc.RunDQL(d.getContext(ctx), req)
 	})
 }
 
 // CreateNamespace creates a new namespace with the given name and password for groot user.
 func (d *Dgraph) CreateNamespace(ctx context.Context, name string) error {
-	req := &apiv25.CreateNamespaceRequest{NsName: name}
-	_, err := doWithRetryLogin(ctx, d, func(dc apiv25.DgraphClient) (*apiv25.CreateNamespaceResponse, error) {
+	req := &apiv2.CreateNamespaceRequest{NsName: name}
+	_, err := doWithRetryLogin(ctx, d, func(dc apiv2.DgraphClient) (*apiv2.CreateNamespaceResponse, error) {
 		return dc.CreateNamespace(d.getContext(ctx), req)
 	})
 	return err
 }
 
 // DropNamespace deletes the namespace with the given name.
 func (d *Dgraph) DropNamespace(ctx context.Context, name string) error {
-	req := &apiv25.DropNamespaceRequest{NsName: name}
-	_, err := doWithRetryLogin(ctx, d, func(dc apiv25.DgraphClient) (*apiv25.DropNamespaceResponse, error) {
+	req := &apiv2.DropNamespaceRequest{NsName: name}
+	_, err := doWithRetryLogin(ctx, d, func(dc apiv2.DgraphClient) (*apiv2.DropNamespaceResponse, error) {
 		return dc.DropNamespace(d.getContext(ctx), req)
 	})
 	return err
 }
 
 // RenameNamespace renames the namespace from the given name to the new name.
 func (d *Dgraph) RenameNamespace(ctx context.Context, from string, to string) error {
-	req := &apiv25.UpdateNamespaceRequest{NsName: from, RenameToNs: to}
-	_, err := doWithRetryLogin(ctx, d, func(dc apiv25.DgraphClient) (*apiv25.UpdateNamespaceResponse, error) {
+	req := &apiv2.UpdateNamespaceRequest{NsName: from, RenameToNs: to}
+	_, err := doWithRetryLogin(ctx, d, func(dc apiv2.DgraphClient) (*apiv2.UpdateNamespaceResponse, error) {
 		return dc.UpdateNamespace(d.getContext(ctx), req)
 	})
 	return err
 }
 
 // ListNamespaces returns a map of namespace names to their details.
-func (d *Dgraph) ListNamespaces(ctx context.Context) (map[string]*apiv25.Namespace, error) {
-	resp, err := doWithRetryLogin(ctx, d, func(dc apiv25.DgraphClient) (*apiv25.ListNamespacesResponse, error) {
-		return dc.ListNamespaces(d.getContext(ctx), &apiv25.ListNamespacesRequest{})
+func (d *Dgraph) ListNamespaces(ctx context.Context) (map[string]*apiv2.Namespace, error) {
+	resp, err := doWithRetryLogin(ctx, d, func(dc apiv2.DgraphClient) (*apiv2.ListNamespacesResponse, error) {
+		return dc.ListNamespaces(d.getContext(ctx), &apiv2.ListNamespacesRequest{})
 	})
 	if err != nil {
 		return nil, err
@@ -124,19 +124,19 @@ func (d *Dgraph) ListNamespaces(ctx context.Context) (map[string]*apiv25.Namespa
 	return resp.NsList, nil
 }
 
-func (d *Dgraph) anyClientv25() apiv25.DgraphClient {
+func (d *Dgraph) anyClientv2() apiv2.DgraphClient {
 	//nolint:gosec
-	return d.dcv25[rand.Intn(len(d.dcv25))]
+	return d.dcv2[rand.Intn(len(d.dcv2))]
 }
 
 func doWithRetryLogin[T any](ctx context.Context, d *Dgraph,
-	f func(dc apiv25.DgraphClient) (*T, error)) (*T, error) {
+	f func(dc apiv2.DgraphClient) (*T, error)) (*T, error) {
 
 	if d.useV1 {
 		return nil, ErrUnsupportedAPI
 	}
 
-	dc := d.anyClientv25()
+	dc := d.anyClientv2()
 	resp, err := f(dc)
 	if isJwtExpired(err) {
 		if err := d.retryLogin(ctx); err != nil {

ns_v25.go renamed to nsv2.go

@@ -8,7 +8,7 @@ patchContent := "package api\n\nimport (\n\tgrpc \"google.golang.org/grpc\"\n)\n
 .PHONY: clean
 clean:
 	@rm -rf api && mkdir -p api
-	@rm -rf api.v25 && mkdir -p api.v25
+	@rm -rf api.v2 && mkdir -p api.v2
 
 .PHONY: check
 check:
@@ -19,6 +19,6 @@ check:
 .PHONY: regenerate
 regenerate: check clean
 	@protoc --go_out=api --go-grpc_out=api --go_opt=paths=source_relative --go-grpc_opt=paths=source_relative api.proto
-	@protoc --go_out=api.v25 --go-grpc_out=api.v25 --go_opt=paths=source_relative --go-grpc_opt=paths=source_relative api.v25.proto
+	@protoc --go_out=api.v2 --go-grpc_out=api.v2 --go_opt=paths=source_relative --go-grpc_opt=paths=source_relative api.v2.proto
 	@echo $(patchContent) > api/cc.go
 	@echo Done.

protos/Makefile

@@ -10,11 +10,11 @@
 
 syntax = "proto3";
 
-package api.v25;
+package api.v2;
 
-option go_package = "github.com/dgraph-io/dgo/v250/protos/api.v25";
+option go_package = "github.com/dgraph-io/dgo/v250/protos/api.v2";
 
-option java_package = "io.dgraph.v25";
+option java_package = "io.dgraph.v2";
 option java_outer_classname = "DgraphProto";
 
 service Dgraph {