All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| ConfigureYCQL | Post /api/v1/customers/{cUUID}/universes/{univUUID}/configure/ycql | Configure YCQL |
| ConfigureYSQL | Post /api/v1/customers/{cUUID}/universes/{univUUID}/configure/ysql | Configure YSQL |
| CreateUserInDB | Post /api/v1/customers/{cUUID}/universes/{uniUUID}/create_db_credentials | Create a database user for a universe |
| RunYsqlQueryUniverse | Post /api/v1/customers/{cUUID}/universes/{uniUUID}/run_query | Run a YSQL query in a universe |
| SetDatabaseCredentials | Post /api/v1/customers/{cUUID}/universes/{uniUUID}/update_db_credentials | Set a universe's database credentials |
YBPTask ConfigureYCQL(ctx, cUUID, univUUID).ConfigureYcqlFormData(configureYcqlFormData).Request(request).Execute()
Configure YCQL
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/yugabyte/platform-go-client/v1"
)
func main() {
cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |
univUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |
configureYcqlFormData := *openapiclient.NewConfigureYCQLFormData() // ConfigureYCQLFormData | Configure YCQL Form Data
request := TODO // interface{} | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UniverseDatabaseManagementAPI.ConfigureYCQL(context.Background(), cUUID, univUUID).ConfigureYcqlFormData(configureYcqlFormData).Request(request).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UniverseDatabaseManagementAPI.ConfigureYCQL``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ConfigureYCQL`: YBPTask
fmt.Fprintf(os.Stdout, "Response from `UniverseDatabaseManagementAPI.ConfigureYCQL`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| cUUID | string | ||
| univUUID | string |
Other parameters are passed through a pointer to a apiConfigureYCQLRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
configureYcqlFormData | ConfigureYCQLFormData | Configure YCQL Form Data | request | interface{} | |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
YBPTask ConfigureYSQL(ctx, cUUID, univUUID).ConfigureYsqlFormData(configureYsqlFormData).Request(request).Execute()
Configure YSQL
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/yugabyte/platform-go-client/v1"
)
func main() {
cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |
univUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |
configureYsqlFormData := *openapiclient.NewConfigureYSQLFormData() // ConfigureYSQLFormData | Configure YSQL Form Data
request := TODO // interface{} | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UniverseDatabaseManagementAPI.ConfigureYSQL(context.Background(), cUUID, univUUID).ConfigureYsqlFormData(configureYsqlFormData).Request(request).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UniverseDatabaseManagementAPI.ConfigureYSQL``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ConfigureYSQL`: YBPTask
fmt.Fprintf(os.Stdout, "Response from `UniverseDatabaseManagementAPI.ConfigureYSQL`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| cUUID | string | ||
| univUUID | string |
Other parameters are passed through a pointer to a apiConfigureYSQLRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
configureYsqlFormData | ConfigureYSQLFormData | Configure YSQL Form Data | request | interface{} | |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
YBPSuccess CreateUserInDB(ctx, cUUID, uniUUID).DatabaseUserFormData(databaseUserFormData).Request(request).Execute()
Create a database user for a universe
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/yugabyte/platform-go-client/v1"
)
func main() {
cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |
uniUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |
databaseUserFormData := *openapiclient.NewDatabaseUserFormData("DbName_example", "Password_example", "Username_example", "YcqlAdminPassword_example", "YcqlAdminUsername_example", "YsqlAdminPassword_example", "YsqlAdminUsername_example") // DatabaseUserFormData | The database user to create
request := TODO // interface{} | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UniverseDatabaseManagementAPI.CreateUserInDB(context.Background(), cUUID, uniUUID).DatabaseUserFormData(databaseUserFormData).Request(request).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UniverseDatabaseManagementAPI.CreateUserInDB``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateUserInDB`: YBPSuccess
fmt.Fprintf(os.Stdout, "Response from `UniverseDatabaseManagementAPI.CreateUserInDB`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| cUUID | string | ||
| uniUUID | string |
Other parameters are passed through a pointer to a apiCreateUserInDBRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
databaseUserFormData | DatabaseUserFormData | The database user to create | request | interface{} | |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]interface{} RunYsqlQueryUniverse(ctx, cUUID, uniUUID).RunQueryFormData(runQueryFormData).Request(request).Execute()
Run a YSQL query in a universe
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/yugabyte/platform-go-client/v1"
)
func main() {
cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |
uniUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |
runQueryFormData := *openapiclient.NewRunQueryFormData("DbName_example", "NodeName_example", "Query_example", "TableType_example") // RunQueryFormData |
request := TODO // interface{} | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UniverseDatabaseManagementAPI.RunYsqlQueryUniverse(context.Background(), cUUID, uniUUID).RunQueryFormData(runQueryFormData).Request(request).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UniverseDatabaseManagementAPI.RunYsqlQueryUniverse``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `RunYsqlQueryUniverse`: map[string]interface{}
fmt.Fprintf(os.Stdout, "Response from `UniverseDatabaseManagementAPI.RunYsqlQueryUniverse`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| cUUID | string | ||
| uniUUID | string |
Other parameters are passed through a pointer to a apiRunYsqlQueryUniverseRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
runQueryFormData | RunQueryFormData | | request | interface{} | |
map[string]interface{}
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
YBPSuccess SetDatabaseCredentials(ctx, cUUID, uniUUID).DatabaseSecurityFormData(databaseSecurityFormData).Request(request).Execute()
Set a universe's database credentials
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/yugabyte/platform-go-client/v1"
)
func main() {
cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |
uniUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |
databaseSecurityFormData := *openapiclient.NewDatabaseSecurityFormData() // DatabaseSecurityFormData | The database credentials
request := TODO // interface{} | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UniverseDatabaseManagementAPI.SetDatabaseCredentials(context.Background(), cUUID, uniUUID).DatabaseSecurityFormData(databaseSecurityFormData).Request(request).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UniverseDatabaseManagementAPI.SetDatabaseCredentials``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `SetDatabaseCredentials`: YBPSuccess
fmt.Fprintf(os.Stdout, "Response from `UniverseDatabaseManagementAPI.SetDatabaseCredentials`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| cUUID | string | ||
| uniUUID | string |
Other parameters are passed through a pointer to a apiSetDatabaseCredentialsRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
databaseSecurityFormData | DatabaseSecurityFormData | The database credentials | request | interface{} | |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]