Merge pull request #215 from planetscale/iheanyi/add-keyspace-create

Add keyspace creation to API

Author: iheanyi

docker-compose.yml

@@ -1,8 +1,8 @@
-version: '2'
+version: "2"
 
 services:
   app:
-    image: golang:1.19
+    image: golang:1.23
     volumes:
       - .:/work
     working_dir: /work

go.mod

@@ -1,6 +1,6 @@
 module github.com/planetscale/planetscale-go
 
-go 1.19
+go 1.23
 
 require (
 	github.com/frankban/quicktest v1.14.6

planetscale/keyspaces.go

@@ -16,7 +16,9 @@ type Keyspace struct {
 	Sharded       bool        `json:"sharded"`
 	Replicas      uint64      `json:"replicas"`
 	ExtraReplicas uint64      `json:"extra_replicas"`
+	ResizePending bool        `json:"resize_pending"`
 	Resizing      bool        `json:"resizing"`
+	Ready         bool        `json:"ready"`
 	ClusterSize   ClusterSize `json:"cluster_rate_name"`
 	CreatedAt     time.Time   `json:"created_at"`
 	UpdatedAt     time.Time   `json:"updated_at"`
@@ -34,6 +36,16 @@ type ListBranchKeyspacesRequest struct {
 	Branch       string `json:"-"`
 }
 
+type CreateBranchKeyspaceRequest struct {
+	Organization  string      `json:"-"`
+	Database      string      `json:"-"`
+	Branch        string      `json:"-"`
+	Name          string      `json:"name"`
+	ClusterSize   ClusterSize `json:"cluster_size"`
+	ExtraReplicas int         `json:"replicas"`
+	Shards        int         `json:"shards"`
+}
+
 type GetBranchKeyspaceRequest struct {
 	Organization string `json:"-"`
 	Database     string `json:"-"`
@@ -62,6 +74,7 @@ type branchKeyspacesResponse struct {
 
 // BranchKeyspaceService is an interface for interacting with the keyspace endpoints of the PlanetScale API
 type BranchKeyspacesService interface {
+	Create(context.Context, *CreateBranchKeyspaceRequest) (*Keyspace, error)
 	List(context.Context, *ListBranchKeyspacesRequest) ([]*Keyspace, error)
 	Get(context.Context, *GetBranchKeyspaceRequest) (*Keyspace, error)
 	VSchema(context.Context, *GetKeyspaceVSchemaRequest) (*VSchema, error)
@@ -108,6 +121,21 @@ func (s *branchKeyspacesService) Get(ctx context.Context, getReq *GetBranchKeysp
 	return keyspace, nil
 }
 
+// Create creates a keyspace for a branch
+func (s *branchKeyspacesService) Create(ctx context.Context, createReq *CreateBranchKeyspaceRequest) (*Keyspace, error) {
+	req, err := s.client.newRequest(http.MethodPost, databaseBranchKeyspacesAPIPath(createReq.Organization, createReq.Database, createReq.Branch), createReq)
+	if err != nil {
+		return nil, errors.Wrap(err, "error creating http request")
+	}
+
+	keyspace := &Keyspace{}
+	if err := s.client.do(ctx, req, keyspace); err != nil {
+		return nil, err
+	}
+
+	return keyspace, nil
+}
+
 // VSchema returns the VSchema for a keyspace in a branch
 func (s *branchKeyspacesService) VSchema(ctx context.Context, getReq *GetKeyspaceVSchemaRequest) (*VSchema, error) {
 	path := fmt.Sprintf("%s/vschema", databaseBranchKeyspaceAPIPath(getReq.Organization, getReq.Database, getReq.Branch, getReq.Keyspace))

planetscale/keyspaces_test.go

@@ -69,6 +69,40 @@ func TestKeyspaces_Get(t *testing.T) {
 	c.Assert(keyspace.Shards, qt.Equals, 2)
 }
 
+func TestKeyspaces_Create(t *testing.T) {
+	c := qt.New(t)
+
+	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		w.WriteHeader(201)
+		out := `{"type":"Keyspace","id":"thisisanid","name":"planetscale","shards":2,"sharded":true,"created_at":"2022-01-14T15:39:28.394Z","updated_at":"2021-12-20T21:11:07.697Z"}`
+		_, err := w.Write([]byte(out))
+		c.Assert(err, qt.IsNil)
+		c.Assert(r.Method, qt.Equals, http.MethodPost)
+	}))
+
+	client, err := NewClient(WithBaseURL(ts.URL))
+	c.Assert(err, qt.IsNil)
+
+	ctx := context.Background()
+
+	keyspace, err := client.Keyspaces.Create(ctx, &CreateBranchKeyspaceRequest{
+		Organization:  "foo",
+		Database:      "bar",
+		Branch:        "baz",
+		Name:          "qux",
+		ClusterSize:   "small",
+		ExtraReplicas: 3,
+		Shards:        2,
+	})
+
+	wantID := "thisisanid"
+
+	c.Assert(err, qt.IsNil)
+	c.Assert(keyspace.ID, qt.Equals, wantID)
+	c.Assert(keyspace.Sharded, qt.Equals, true)
+	c.Assert(keyspace.Shards, qt.Equals, 2)
+}
+
 func TestKeyspaces_VSchema(t *testing.T) {
 	c := qt.New(t)