Skip to content

Add with_replication to Postgres roles #323

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joshmgross merged 1 commit into from
Jul 8, 2026
+42 −34
Merged

Add with_replication to Postgres roles #323

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 16 additions & 14 deletions planetscale/postgres_roles.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,15 @@ import (

// PostgresRole represents a PostgreSQL role in PlanetScale.
type PostgresRole struct {
ID string `json:"id"`
Name string `json:"name"`
AccessHostURL string `json:"access_host_url"`
DatabaseName string `json:"database_name"`
Password string `json:"password"`
Actor Actor `json:"actor"`
Username string `json:"username"`
CreatedAt time.Time `json:"created_at"`
ID string `json:"id"`
Name string `json:"name"`
AccessHostURL string `json:"access_host_url"`
DatabaseName string `json:"database_name"`
Password string `json:"password"`
Actor Actor `json:"actor"`
Username string `json:"username"`
WithReplication bool `json:"with_replication"`
CreatedAt time.Time `json:"created_at"`
}

type postgresRolesResponse struct {
Expand All @@ -41,12 +42,13 @@ type GetPostgresRoleRequest struct {

// CreatePostgresRoleRequest encapsulates the request for creating role credentials for a database branch.
type CreatePostgresRoleRequest struct {
Organization string `json:"-"`
Database string `json:"-"`
Branch string `json:"-"`
Name string `json:"name"`
TTL int `json:"ttl,omitempty"`
InheritedRoles []string `json:"inherited_roles,omitempty"`
Organization string `json:"-"`
Database string `json:"-"`
Branch string `json:"-"`
Name string `json:"name"`
TTL int `json:"ttl,omitempty"`
InheritedRoles []string `json:"inherited_roles,omitempty"`
WithReplication bool `json:"with_replication,omitempty"`
}

// UpdatePostgresRoleRequest encapsulates the request for updating a role name for a database branch.
Expand Down
46 changes: 26 additions & 20 deletions planetscale/postgres_roles_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,7 @@ func TestPostgresRoles_Get(t *testing.T) {
"database_name": "test-db",
"password": "secret-password",
"username": "test-user",
"with_replication": true,
"created_at": "2021-01-14T10:19:23.000Z"
}`, testRoleID)
_, err := w.Write([]byte(out))
Expand All @@ -240,13 +241,14 @@ func TestPostgresRoles_Get(t *testing.T) {
})

want := &PostgresRole{
ID: testRoleID,
Name: "test-role",
AccessHostURL: "test.planetscale.com",
DatabaseName: "test-db",
Password: "secret-password",
Username: "test-user",
CreatedAt: time.Date(2021, time.January, 14, 10, 19, 23, 0, time.UTC),
ID: testRoleID,
Name: "test-role",
AccessHostURL: "test.planetscale.com",
DatabaseName: "test-db",
Password: "secret-password",
Username: "test-user",
WithReplication: true,
CreatedAt: time.Date(2021, time.January, 14, 10, 19, 23, 0, time.UTC),
}

c.Assert(err, qt.IsNil)
Expand All @@ -269,6 +271,7 @@ func TestPostgresRoles_Create(t *testing.T) {
c.Assert(reqBody.Name, qt.Equals, "new-role")
c.Assert(reqBody.TTL, qt.Equals, 3600)
c.Assert(reqBody.InheritedRoles, qt.DeepEquals, []string{"pg_read_all_data", "pg_write_all_data"})
c.Assert(reqBody.WithReplication, qt.Equals, true)

w.WriteHeader(200)
out := fmt.Sprintf(`{
Expand All @@ -278,6 +281,7 @@ func TestPostgresRoles_Create(t *testing.T) {
"database_name": "test-db",
"password": "generated-password",
"username": "new-user",
"with_replication": true,
"created_at": "2021-01-14T10:19:23.000Z"
}`, testRoleID)
_, writeErr := w.Write([]byte(out))
Expand All @@ -293,22 +297,24 @@ func TestPostgresRoles_Create(t *testing.T) {
branch := "my-branch"

role, err := client.PostgresRoles.Create(ctx, &CreatePostgresRoleRequest{
Organization: org,
Database: db,
Branch: branch,
Name: "new-role",
TTL: 3600,
InheritedRoles: []string{"pg_read_all_data", "pg_write_all_data"},
Organization: org,
Database: db,
Branch: branch,
Name: "new-role",
TTL: 3600,
InheritedRoles: []string{"pg_read_all_data", "pg_write_all_data"},
WithReplication: true,
})

want := &PostgresRole{
ID: testRoleID,
Name: "new-role",
AccessHostURL: "test.planetscale.com",
DatabaseName: "test-db",
Password: "generated-password",
Username: "new-user",
CreatedAt: time.Date(2021, time.January, 14, 10, 19, 23, 0, time.UTC),
ID: testRoleID,
Name: "new-role",
AccessHostURL: "test.planetscale.com",
DatabaseName: "test-db",
Password: "generated-password",
Username: "new-user",
WithReplication: true,
CreatedAt: time.Date(2021, time.January, 14, 10, 19, 23, 0, time.UTC),
}

c.Assert(err, qt.IsNil)
Expand Down
Loading