Skip to content

Commit

Permalink
Rename BranchKeyspace to Keyspace (#221)
Browse files Browse the repository at this point in the history
  • Loading branch information
@iheanyi
iheanyi authored Oct 14, 2024
1 parent 429534f commit ac11e88
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 42 deletions.
4 changes: 2 additions & 2 deletions planetscale/client.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ type Client struct {
Regions RegionsService
DeployRequests DeployRequestsService
ServiceTokens ServiceTokenService
Keyspaces BranchKeyspacesService
Keyspaces KeyspacesService
}

// ListOptions are options for listing responses.
Expand Down Expand Up @@ -255,7 +255,7 @@ func NewClient(opts ...ClientOption) (*Client, error) {
c.Regions = &regionsService{client: c}
c.DeployRequests = &deployRequestsService{client: c}
c.ServiceTokens = &serviceTokenService{client: c}
c.Keyspaces = &branchKeyspacesService{client: c}
c.Keyspaces = &keyspacesService{client: c}

return c, nil
}
Expand Down
74 changes: 37 additions & 37 deletions planetscale/keyspaces.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@ type VSchema struct {
HTML string `json:"html"`
}

type ListBranchKeyspacesRequest struct {
type ListKeyspacesRequest struct {
Organization string `json:"-"`
Database string `json:"-"`
Branch string `json:"-"`
}

type CreateBranchKeyspaceRequest struct {
type CreateKeyspaceRequest struct {
Organization string `json:"-"`
Database string `json:"-"`
Branch string `json:"-"`
Expand All @@ -46,7 +46,7 @@ type CreateBranchKeyspaceRequest struct {
Shards int `json:"shards"`
}

type GetBranchKeyspaceRequest struct {
type GetKeyspaceRequest struct {
Organization string `json:"-"`
Database string `json:"-"`
Branch string `json:"-"`
Expand All @@ -68,7 +68,7 @@ type UpdateKeyspaceVSchemaRequest struct {
VSchema string `json:"vschema"`
}

type branchKeyspacesResponse struct {
type keyspacesResponse struct {
Keyspaces []*Keyspace `json:"data"`
}

Expand Down Expand Up @@ -113,46 +113,46 @@ type KeyspaceResizeStatusRequest struct {
Keyspace string `json:"-"`
}

// 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)
// KeyspacesService is an interface for interacting with the keyspace endpoints of the PlanetScale API
type KeyspacesService interface {
Create(context.Context, *CreateKeyspaceRequest) (*Keyspace, error)
List(context.Context, *ListKeyspacesRequest) ([]*Keyspace, error)
Get(context.Context, *GetKeyspaceRequest) (*Keyspace, error)
VSchema(context.Context, *GetKeyspaceVSchemaRequest) (*VSchema, error)
UpdateVSchema(context.Context, *UpdateKeyspaceVSchemaRequest) (*VSchema, error)
Resize(context.Context, *ResizeKeyspaceRequest) (*KeyspaceResizeRequest, error)
CancelResize(context.Context, *CancelKeyspaceResizeRequest) error
ResizeStatus(context.Context, *KeyspaceResizeStatusRequest) (*KeyspaceResizeRequest, error)
}

type branchKeyspacesService struct {
type keyspacesService struct {
client *Client
}

var _ BranchKeyspacesService = &branchKeyspacesService{}
var _ KeyspacesService = &keyspacesService{}

func NewBranchKeyspacesService(client *Client) *branchKeyspacesService {
return &branchKeyspacesService{client}
func NewKeyspacesService(client *Client) *keyspacesService {
return &keyspacesService{client}
}

// List returns a list of keyspaces for a branch
func (s *branchKeyspacesService) List(ctx context.Context, listReq *ListBranchKeyspacesRequest) ([]*Keyspace, error) {
req, err := s.client.newRequest(http.MethodGet, databaseBranchKeyspacesAPIPath(listReq.Organization, listReq.Database, listReq.Branch), nil)
func (s *keyspacesService) List(ctx context.Context, listReq *ListKeyspacesRequest) ([]*Keyspace, error) {
req, err := s.client.newRequest(http.MethodGet, keyspacesAPIPath(listReq.Organization, listReq.Database, listReq.Branch), nil)
if err != nil {
return nil, errors.Wrap(err, "error creating http request")
}

branchKeyspaces := &branchKeyspacesResponse{}
if err := s.client.do(ctx, req, branchKeyspaces); err != nil {
keyspaces := &keyspacesResponse{}
if err := s.client.do(ctx, req, keyspaces); err != nil {
return nil, err
}

return branchKeyspaces.Keyspaces, nil
return keyspaces.Keyspaces, nil
}

// Get returns a keyspace for a branch
func (s *branchKeyspacesService) Get(ctx context.Context, getReq *GetBranchKeyspaceRequest) (*Keyspace, error) {
req, err := s.client.newRequest(http.MethodGet, databaseBranchKeyspaceAPIPath(getReq.Organization, getReq.Database, getReq.Branch, getReq.Keyspace), nil)
func (s *keyspacesService) Get(ctx context.Context, getReq *GetKeyspaceRequest) (*Keyspace, error) {
req, err := s.client.newRequest(http.MethodGet, keyspaceAPIPath(getReq.Organization, getReq.Database, getReq.Branch, getReq.Keyspace), nil)
if err != nil {
return nil, errors.Wrap(err, "error creating http request")
}
Expand All @@ -166,8 +166,8 @@ func (s *branchKeyspacesService) Get(ctx context.Context, getReq *GetBranchKeysp
}

// 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)
func (s *keyspacesService) Create(ctx context.Context, createReq *CreateKeyspaceRequest) (*Keyspace, error) {
req, err := s.client.newRequest(http.MethodPost, keyspacesAPIPath(createReq.Organization, createReq.Database, createReq.Branch), createReq)
if err != nil {
return nil, errors.Wrap(err, "error creating http request")
}
Expand All @@ -181,8 +181,8 @@ func (s *branchKeyspacesService) Create(ctx context.Context, createReq *CreateBr
}

// 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))
func (s *keyspacesService) VSchema(ctx context.Context, getReq *GetKeyspaceVSchemaRequest) (*VSchema, error) {
path := fmt.Sprintf("%s/vschema", keyspaceAPIPath(getReq.Organization, getReq.Database, getReq.Branch, getReq.Keyspace))
req, err := s.client.newRequest(http.MethodGet, path, nil)
if err != nil {
return nil, errors.Wrap(err, "error creating http request")
Expand All @@ -196,8 +196,8 @@ func (s *branchKeyspacesService) VSchema(ctx context.Context, getReq *GetKeyspac
return vschema, nil
}

func (s *branchKeyspacesService) UpdateVSchema(ctx context.Context, updateReq *UpdateKeyspaceVSchemaRequest) (*VSchema, error) {
path := fmt.Sprintf("%s/vschema", databaseBranchKeyspaceAPIPath(updateReq.Organization, updateReq.Database, updateReq.Branch, updateReq.Keyspace))
func (s *keyspacesService) UpdateVSchema(ctx context.Context, updateReq *UpdateKeyspaceVSchemaRequest) (*VSchema, error) {
path := fmt.Sprintf("%s/vschema", keyspaceAPIPath(updateReq.Organization, updateReq.Database, updateReq.Branch, updateReq.Keyspace))
req, err := s.client.newRequest(http.MethodPatch, path, updateReq)
if err != nil {
return nil, errors.Wrap(err, "error creating http request")
Expand All @@ -212,8 +212,8 @@ func (s *branchKeyspacesService) UpdateVSchema(ctx context.Context, updateReq *U
}

// Resize starts or queues a resize of a branch's keyspace.
func (s *branchKeyspacesService) Resize(ctx context.Context, resizeReq *ResizeKeyspaceRequest) (*KeyspaceResizeRequest, error) {
req, err := s.client.newRequest(http.MethodPut, databaseBranchKeyspaceResizesAPIPath(resizeReq.Organization, resizeReq.Database, resizeReq.Branch, resizeReq.Keyspace), resizeReq)
func (s *keyspacesService) Resize(ctx context.Context, resizeReq *ResizeKeyspaceRequest) (*KeyspaceResizeRequest, error) {
req, err := s.client.newRequest(http.MethodPut, keyspaceResizesAPIPath(resizeReq.Organization, resizeReq.Database, resizeReq.Branch, resizeReq.Keyspace), resizeReq)
if err != nil {
return nil, errors.Wrap(err, "error creating http request")
}
Expand All @@ -227,33 +227,33 @@ func (s *branchKeyspacesService) Resize(ctx context.Context, resizeReq *ResizeKe
}

// CancelResize cancels a queued resize of a branch's keyspace.
func (s *branchKeyspacesService) CancelResize(ctx context.Context, cancelReq *CancelKeyspaceResizeRequest) error {
req, err := s.client.newRequest(http.MethodDelete, databaseBranchKeyspaceResizesAPIPath(cancelReq.Organization, cancelReq.Database, cancelReq.Branch, cancelReq.Keyspace), nil)
func (s *keyspacesService) CancelResize(ctx context.Context, cancelReq *CancelKeyspaceResizeRequest) error {
req, err := s.client.newRequest(http.MethodDelete, keyspaceResizesAPIPath(cancelReq.Organization, cancelReq.Database, cancelReq.Branch, cancelReq.Keyspace), nil)
if err != nil {
return errors.Wrap(err, "error creating http request")
}

return s.client.do(ctx, req, nil)
}

func databaseBranchKeyspacesAPIPath(org, db, branch string) string {
func keyspacesAPIPath(org, db, branch string) string {
return fmt.Sprintf("%s/keyspaces", databaseBranchAPIPath(org, db, branch))
}

func databaseBranchKeyspaceAPIPath(org, db, branch, keyspace string) string {
return fmt.Sprintf("%s/%s", databaseBranchKeyspacesAPIPath(org, db, branch), keyspace)
func keyspaceAPIPath(org, db, branch, keyspace string) string {
return fmt.Sprintf("%s/%s", keyspacesAPIPath(org, db, branch), keyspace)
}

func databaseBranchKeyspaceResizesAPIPath(org, db, branch, keyspace string) string {
return fmt.Sprintf("%s/resizes", databaseBranchKeyspaceAPIPath(org, db, branch, keyspace))
func keyspaceResizesAPIPath(org, db, branch, keyspace string) string {
return fmt.Sprintf("%s/resizes", keyspaceAPIPath(org, db, branch, keyspace))
}

type keyspaceResizesResponse struct {
Resizes []*KeyspaceResizeRequest `json:"data"`
}

func (s *branchKeyspacesService) ResizeStatus(ctx context.Context, resizeReq *KeyspaceResizeStatusRequest) (*KeyspaceResizeRequest, error) {
req, err := s.client.newRequest(http.MethodGet, databaseBranchKeyspaceResizesAPIPath(resizeReq.Organization, resizeReq.Database, resizeReq.Branch, resizeReq.Keyspace), nil)
func (s *keyspacesService) ResizeStatus(ctx context.Context, resizeReq *KeyspaceResizeStatusRequest) (*KeyspaceResizeRequest, error) {
req, err := s.client.newRequest(http.MethodGet, keyspaceResizesAPIPath(resizeReq.Organization, resizeReq.Database, resizeReq.Branch, resizeReq.Keyspace), nil)
if err != nil {
return nil, errors.Wrap(err, "error creating http request")
}
Expand Down
6 changes: 3 additions & 3 deletions planetscale/keyspaces_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ func TestKeyspaces_List(t *testing.T) {

ctx := context.Background()

keyspaces, err := client.Keyspaces.List(ctx, &ListBranchKeyspacesRequest{
keyspaces, err := client.Keyspaces.List(ctx, &ListKeyspacesRequest{
Organization: "foo",
Database: "bar",
Branch: "baz",
Expand Down Expand Up @@ -54,7 +54,7 @@ func TestKeyspaces_Get(t *testing.T) {

ctx := context.Background()

keyspace, err := client.Keyspaces.Get(ctx, &GetBranchKeyspaceRequest{
keyspace, err := client.Keyspaces.Get(ctx, &GetKeyspaceRequest{
Organization: "foo",
Database: "bar",
Branch: "baz",
Expand Down Expand Up @@ -85,7 +85,7 @@ func TestKeyspaces_Create(t *testing.T) {

ctx := context.Background()

keyspace, err := client.Keyspaces.Create(ctx, &CreateBranchKeyspaceRequest{
keyspace, err := client.Keyspaces.Create(ctx, &CreateKeyspaceRequest{
Organization: "foo",
Database: "bar",
Branch: "baz",
Expand Down

0 comments on commit ac11e88

Please sign in to comment.