Golang SDK for Singlestore Management API

SDK Installation

go get github.com/speakeasy-sdks/singlestore-sample-sdk

SDK Example Usage

package main

import (
	"context"
	"log"

	singlestoresamplesdk "github.com/speakeasy-sdks/singlestore-sample-sdk"
	"github.com/speakeasy-sdks/singlestore-sample-sdk/pkg/models/operations"
)

func main() {
	s := singlestoresamplesdk.New(
		singlestoresamplesdk.WithSecurity("api-auth-key"),
	)

	endTime := ""
	startTime := ""
	aggregateBy := operations.ListBillingUsageAggregateByHour
	metric := operations.ListBillingUsageMetricComputeCredit

	ctx := context.Background()
	res, err := s.Billing.List(ctx, endTime, startTime, &aggregateBy, &metric)
	if err != nil {
		log.Fatal(err)
	}

	if res.BillingUsage != nil {
		// handle response
	}
}

Available Resources and Operations

Billing

• List - Lists the compute and storage usage of a organization

Organizations

• Get - Gets information about the current organization

PrivateConnection

• Create - Creates a new private connection
• Delete - Deletes a private connection
• Get - Gets information about a private connection
• Update - Updates a private connection

Regions

• List - Lists all of the regions for the user that support workspaces

Stages

• Create - Creates a new folder or uploads a file
• Delete - Deletes a file or folder
• Get - Gets information about a folder or downloads a file
• Update - Modifies a file or folder in Stages

WorkspaceGroups

• Create - Creates a new workspace group
• CreateStorage - Sets up Storage DR for the workspace group. Backup region and selected databases to be replicated are provided as part of the request.
• Delete - Terminates a workspace group
• Get - Gets information about a workspace group
• GetPrivateConnection - Gets private connection information for a workspace group
• GetRecoveryBackup - Gets information about which regions you can setup as a disaster recovery backup
• GetStorageStatus - Gets information about the storage DR status of the workspace group
• List - Lists the workspace groups the user can access
• Update - Updates a workspace group
• UpdateFailback - Starts failback to the primary region
• UpdateFailover - Starts failover to the secondary region
• UpdateStartFailoverTestMode - Starts Failover test mode
• UpdateStopFailoverTestMode - Stops Failover test mode

Workspaces

• Create - Creates a new workspace
• CreateResume - Resumes a workspace
• CreateStorage - Sets up Storage DR for the workspace group of the provided workspace. Backup region and selected databases to be replicated are provided as part of the request.
• CreateSuspend - Suspends a workspace
• Delete - Terminates a workspace
• Get - Gets information about a workspace
• GetOutbound - Gets the outbound allow list for a workspace
• GetPrivateConnection - Gets private connection information for a workspace
• GetRecoveryBackup - Gets information about which regions you can setup as a disaster recovery backup
• GetStorageStatus - Gets information about the storage DR status of the group in which the provided workspace belongs to
• List - Lists the workspaces the user can access
• Update - Updates information about a workspace
• UpdateFailback - Starts failback to the primary region
• UpdateFailover - Starts failover to the secondary region
• UpdateStartFailoverTestMode - Starts Failover test mode
• UpdateStopFailoverTestMode - Stops Failover test mode

Dev Containers

Experience our SDK in an enhanced sandbox environment. Try it now in GitHub Codespaces!

• Explore Dev Containers

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy