ndb_api

package

Versions in this module

v0

v0.5.5

Apr 30, 2026

Changes in this version

+ func DeprovisionDPC(ctx context.Context, ndbClient ndb_client.NDBClientHTTPInterface, dpcId string, ...) (operationId string, err error)

+ func DeprovisionHADatabaseServers(ctx context.Context, ndbClient ndb_client.NDBClientHTTPInterface, ...) (operationIds []string, err error)

+ func GetHAProxyIPsForCluster(ctx context.Context, ndbClient ndb_client.NDBClientHTTPInterface, ...) (ips []string, err error)

+ type DBServerDetails struct

+ DbserverClusterId string

+ IPAddresses []string

+ Id string

+ Name string

+ func GetAllDatabaseServers(ctx context.Context, ndbClient ndb_client.NDBClientHTTPInterface) (servers []DBServerDetails, err error)

+ func GetDatabaseServer(ctx context.Context, ndbClient ndb_client.NDBClientHTTPInterface, id string) (server *DBServerDetails, err error)

+ type DPCClusterInfo struct

+ EtcdPort int

+ PatroniClusterName string

+ ProxyInfo DPCProxyInfo

+ type DPCDBServersOptions struct

+ Delete bool

+ DeleteVgs bool

+ DeleteVmSnapshots bool

+ type DPCDeprovisionRequest struct

+ DBServers DPCDBServersOptions

+ Delete bool

+ Forced bool

+ Remove bool

+ SoftRemove bool

+ func GenerateDeprovisionDPCRequest() *DPCDeprovisionRequest

+ type DPCInfo struct

+ Info DPCInnerInfo

+ type DPCInnerInfo struct

+ ClusterInfo DPCClusterInfo

+ type DPCProxyInfo struct

+ ClusterIP string

+ ProxyNodeList []DPCProxyNode

+ type DPCProxyNode struct

+ HostIP string

+ HostName string

+ type DPCResponse struct

+ Id string

+ Info json.RawMessage

+ Name string

+ func GetDPC(ctx context.Context, ndbClient ndb_client.NDBClientHTTPInterface, dpcId string) (dpc *DPCResponse, err error)

+ func (r *DPCResponse) GetDPCInfo() (DPCInfo, error)

type DatabaseInterface

+ GetInstanceHAConfig func() *HAConfig

+ IsPostgresHA func() bool

type DatabaseNode

+ Properties []Property

+ type HAConfig struct

+ ClusterName string

+ EnableSynchronousMode bool

+ Nodes []HANodeConfig

+ PatroniClusterName string

+ ProvisionVirtualIP bool

+ ReadPort int32

+ WritePort int32

+ type HANodeConfig struct

+ ClusterId string

+ FailoverMode string

+ NodeType string

+ Role string

+ VmName string

+ type NodeProperty struct

+ Name string

+ Value string

+ type OracleRequestAppender struct

+ type PrimarySlaDetails struct

+ NxClusterIds []string

+ SlaId string

+ type SlaDetails struct

+ PrimarySla PrimarySlaDetails

type TimeMachineInfo

+ SlaDetails *SlaDetails

v0.5.4

Apr 2, 2026

Changes in this version

+ func GetLatestSnapshotForTM(ctx context.Context, ndbClient *ndb_client.NDBClient, timeMachineId string) (snapshotId string, err error)

v0.5.3

Mar 3, 2026

Changes in this version

+ func ResolveClusterNameToId(ctx context.Context, ndbClient *ndb_client.NDBClient, clusterName string) (clusterId string, err error)

+ func ResolveSnapshotNameToId(ctx context.Context, ndbClient *ndb_client.NDBClient, snapshotName string, ...) (snapshotId string, err error)

+ func ResolveSourceDatabaseNameToId(ctx context.Context, ndbClient *ndb_client.NDBClient, databaseName string) (databaseId string, err error)

+ type ClusterResponse struct

+ Id string

+ Name string

+ func GetAllClusters(ctx context.Context, ndbClient ndb_client.NDBClientHTTPInterface) (clusters []ClusterResponse, err error)

type SnapshotResponse

+ SnapshotTimeStampDate int64

+ func GetSnapshotById(ctx context.Context, ndbClient ndb_client.NDBClientHTTPInterface, ...) (snapshot *SnapshotResponse, err error)

v0.5.2

Jan 29, 2026

v0.5.1

Apr 22, 2024

Changes in this version

type DatabaseResponse

+ func GetCloneById(ctx context.Context, ndbClient *ndb_client.NDBClient, id string) (clone *DatabaseResponse, err error)

+ func GetDatabaseByName(ctx context.Context, ndbClient *ndb_client.NDBClient, name string) (database *DatabaseResponse, err error)

type DatabaseServer

+ NxClusterId string

+ type Snapshot struct

+ Id string

+ type SnapshotLcmConfig struct

+ SnapshotLCMConfigDetailed SnapshotLcmConfigDetailed

+ type SnapshotLcmConfigDetailed struct

+ ExpiryDetails ExpiryDetails

+ type SnapshotRequest struct

+ Name string

+ SnapshotLcmConfig SnapshotLcmConfig

+ func GenerateSnapshotRequest(name string, expiryDateTimezone string, ExpireInDays string) *SnapshotRequest

+ type SnapshotResponse struct

+ Description string

+ Id string

+ Name string

+ SnapshotId string

+ SnapshotUuid string

+ TimeMachineId string

+ type SnapshotsParentInfoPerCluster struct

+ Snapshots []Snapshot

type TaskInfoSummaryResponse

+ func CreateSnapshotForTM(ctx context.Context, ndbClient ndb_client.NDBClientHTTPInterface, tmId string, ...) (task *TaskInfoSummaryResponse, err error)

+ type TimeMachineContinuousSchedule struct

+ LogBackupInterval int

+ SnapshotsPerDay int

+ type TimeMachineGetSnapshotsResponse struct

+ SnapshotsPerNxCluster map[string][]SnapshotsParentInfoPerCluster

+ func GetSnapshotsForTM(ctx context.Context, ndbClient ndb_client.NDBClientHTTPInterface, tmId string) (response *TimeMachineGetSnapshotsResponse, err error)

+ type TimeMachineMonthlySchedule struct

+ DayOfMonth int

+ type TimeMachineQuarterlySchedule struct

+ StartMonth string

+ type TimeMachineResponse struct

+ DatabaseId string

+ Description string

+ Id string

+ Name string

+ Schedule TimeMachineSchedule

+ Sla TimeMachineSLA

+ Status string

+ func GetTimeMachineById(ctx context.Context, ndbClient ndb_client.NDBClientHTTPInterface, tmId string) (timeMachine *TimeMachineResponse, err error)

+ type TimeMachineSLA struct

+ Id string

+ Name string

+ type TimeMachineSchedule struct

+ ContinuousSchedule TimeMachineContinuousSchedule

+ Id string

+ MonthlySchedule TimeMachineMonthlySchedule

+ Name string

+ QuarterlySchedule TimeMachineQuarterlySchedule

+ SnapshotTimeOfDay TimeMachineSnapshotTimeOfDay

+ WeeklySchedule TimeMachineWeeklySchedule

+ type TimeMachineSnapshotTimeOfDay struct

+ Hours int

+ Minutes int

+ Seconds int

+ type TimeMachineWeeklySchedule struct

+ DayOfWeek string

v0.5.0

Nov 7, 2023

v0.0.8

Nov 6, 2023

Changes in this version

+ const OPERATION_STATUS_FAILED

+ const OPERATION_STATUS_PASSED

+ func GetDatabaseTypeFromEngine(engine string) string

+ func GetOperationStatus(o OperationResponse) string

+ type CloneDeprovisionRequest struct

+ Delete bool

+ DeleteDataDrives bool

+ DeleteLogicalCluster bool

+ DeleteTimeMachine bool

+ Forced bool

+ Remove bool

+ RemoveLogicalCluster bool

+ SoftRemove bool

+ func GenerateDeprovisionCloneRequest() (req *CloneDeprovisionRequest)

+ type DatabaseCloneRequest struct

+ ActionArguments []ActionArgument

+ Clustered bool

+ ComputeProfileId string

+ CreateDbServer bool

+ DatabaseParameterProfileId string

+ DbServerClusterId string

+ DbServerId string

+ DbserverLogicalClusterId string

+ Description string

+ LatestSnapshot bool

+ LcmConfig *LcmConfig

+ Name string

+ NetworkProfileId string

+ NodeCount int

+ Nodes []Node

+ NxClusterId string

+ SSHPublicKey string

+ SnapshotId string

+ Tags interface{}

+ TimeMachineId string

+ TimeZone string

+ UserPitrTimestamp string

+ VmPassword string

+ func GenerateCloningRequest(ctx context.Context, ndb_client *ndb_client.NDBClient, ...) (requestBody *DatabaseCloneRequest, err error)

type DatabaseInterface

+ GetAdditionalArguments func() map[string]string

+ GetCloneSnapshotId func() string

+ GetCloneSourceDBId func() string

+ GetClusterId func() string

+ GetCredentialSecret func() string

+ GetDescription func() string

+ GetInstanceDatabaseNames func() string

+ GetInstanceSize func() int

+ GetInstanceTMDetails func() (string, string, string)

+ GetInstanceType func() string

+ GetName func() string

+ GetTMScheduleForInstance func() (Schedule, error)

+ GetTimeZone func() string

+ IsClone func() bool

+ type DatabaseLCMConfig struct

+ ExpiryDetails ExpiryDetails

+ RefreshDetails RefreshDetails

type DatabaseResponse

+ TimeMachineId string

+ Type string

+ func GetAllClones(ctx context.Context, ndbClient *ndb_client.NDBClient) (clones []DatabaseResponse, err error)

+ type ExpiryDetails struct

+ DeleteDatabase string

+ ExpireInDays string

+ ExpiryDateTimezone string

+ type LcmConfig struct

+ DatabaseLCMConfig DatabaseLCMConfig

+ type MSSQLRequestAppender struct

+ type MongoDbRequestAppender struct

+ type MySqlRequestAppender struct

type Node

+ ComputeProfileId string

+ NetworkProfileId string

+ NewDbServerTimeZone string

+ NxClusterId string

+ type OperationResponse struct

+ EndTime string

+ Id string

+ Message string

+ Name string

+ PercentageComplete string

+ StartTime string

+ Status string

+ func GetOperationById(ctx context.Context, ndbClient *ndb_client.NDBClient, id string) (operation OperationResponse, err error)

+ type PostgresRequestAppender struct

+ type RefreshDetails struct

+ RefreshDateTimezone string

+ RefreshInDays string

+ RefreshTime string

+ type RequestAppender interface

+ func GetRequestAppender(databaseType string) (requestAppender RequestAppender, err error)

type TaskInfoSummaryResponse

+ func DeprovisionClone(ctx context.Context, ndbClient *ndb_client.NDBClient, id string, ...) (task TaskInfoSummaryResponse, err error)

+ func ProvisionClone(ctx context.Context, ndbClient *ndb_client.NDBClient, ...) (task TaskInfoSummaryResponse, err error)

v0.0.7

Aug 22, 2023

Changes in this version

+ type AuthValidateResponse struct

+ Message string

+ Status string

+ func AuthValidate(ctx context.Context, ndbClient *ndb_client.NDBClient) (authValidateResponse AuthValidateResponse, err error)

type DatabaseInterface

+ GetDBInstanceDescription func() string

v0.0.6

Jul 24, 2023

Changes in this version

+ type ContinuousSchedule struct

+ Enabled bool

+ LogBackupInterval int

+ SnapshotsPerDay int

type DatabaseInterface

+ GetTMDetails func() (string, string, string)

+ GetTMSchedule func() (Schedule, error)

+ type MonthlySchedule struct

+ DayOfMonth int

+ Enabled bool

+ type QuarterlySchedule struct

+ DayOfMonth int

+ Enabled bool

+ StartMonth string

type SLAResponse

+ func GetSLAByName(ctx context.Context, ndb_client *ndb_client.NDBClient, name string) (sla SLAResponse, err error)

+ type Schedule struct

+ ContinuousSchedule ContinuousSchedule

+ MonthlySchedule MonthlySchedule

+ QuarterlySchedule QuarterlySchedule

+ SnapshotTimeOfDay SnapshotTimeOfDay

+ WeeklySchedule WeeklySchedule

+ YearlySchedule YearlySchedule

+ type SnapshotTimeOfDay struct

+ Hours int

+ Minutes int

+ Seconds int

+ type WeeklySchedule struct

+ DayOfWeek string

+ Enabled bool

+ type YearlySchedule struct

+ DayOfMonth int

+ Enabled bool

+ Month string

v0.0.5

Jun 21, 2023

Changes in this version

+ var ComputeOOBProfileResolver = func(p ProfileResponse) bool

+ var DbParamInstanceOOBProfileResolver = func(p ProfileResponse) bool

+ var DbParamOOBProfileResolver = func(p ProfileResponse) bool

+ var NetworkOOBProfileResolver = func(p ProfileResponse) bool

+ var SoftwareOOBProfileResolverForSingleInstance = func(p ProfileResponse) bool

+ func GetDatabaseEngineName(dbType string) string

+ func GetDatabasePortByType(dbType string) int32

+ func ResolveProfiles(ctx context.Context, ndb_client *ndb_client.NDBClient, databaseType string, ...) (profilesMap map[string]ProfileResponse, err error)

+ type ActionArgument struct

+ Name string

+ Value string

+ type DBProvisionRequestAppender interface

+ func GetDbProvRequestAppender(databaseType string) (requestAppender DBProvisionRequestAppender, err error)

+ type DatabaseDeprovisionRequest struct

+ Delete bool

+ DeleteLogicalCluster bool

+ DeleteTimeMachine bool

+ Forced bool

+ Remove bool

+ SoftRemove bool

+ func GenerateDeprovisionDatabaseRequest() (req *DatabaseDeprovisionRequest)

+ type DatabaseInterface interface

+ GetDBInstanceDatabaseNames func() string

+ GetDBInstanceName func() string

+ GetDBInstanceSize func() int

+ GetDBInstanceTimeZone func() string

+ GetDBInstanceType func() string

+ GetNDBClusterId func() string

+ GetProfileResolvers func() ProfileResolvers

+ type DatabaseNode struct

+ DatabaseServerId string

+ DbServer DatabaseServer

+ Id string

+ Name string

+ type DatabaseProvisionRequest struct

+ ActionArguments []ActionArgument

+ AutoTuneStagingDrive bool

+ Clustered bool

+ ComputeProfileId string

+ CreateDbServer bool

+ DatabaseDescription string

+ DatabaseName string

+ DatabaseType string

+ DbParameterProfileId string

+ Name string

+ NetworkProfileId string

+ NewDbServerTimeZone string

+ NodeCount int

+ Nodes []Node

+ NxClusterId string

+ SSHPublicKey string

+ SoftwareProfileId string

+ SoftwareProfileVersionId string

+ TimeMachineInfo TimeMachineInfo

+ func GenerateProvisioningRequest(ctx context.Context, ndb_client *ndb_client.NDBClient, ...) (requestBody *DatabaseProvisionRequest, err error)

+ type DatabaseResponse struct

+ DatabaseNodes []DatabaseNode

+ Id string

+ Name string

+ Properties []Property

+ Status string

+ func GetAllDatabases(ctx context.Context, ndbClient *ndb_client.NDBClient) (databases []DatabaseResponse, err error)

+ func GetDatabaseById(ctx context.Context, ndbClient *ndb_client.NDBClient, id string) (database DatabaseResponse, err error)

+ type DatabaseServer struct

+ IPAddresses []string

+ Id string

+ Name string

+ type DatabaseServerDeprovisionRequest struct

+ Delete bool

+ DeleteVgs bool

+ DeleteVmSnapshots bool

+ Remove bool

+ SoftRemove bool

+ func GenerateDeprovisionDatabaseServerRequest() (req *DatabaseServerDeprovisionRequest)

+ type MSSQLProvisionRequestAppender struct

+ type MongoDbProvisionRequestAppender struct

+ type MySqlProvisionRequestAppender struct

+ type Node struct

+ Properties []string

+ VmName string

+ type PostgresProvisionRequestAppender struct

+ type ProfileResolver interface

+ GetId func() string

+ GetName func() string

+ Resolve func(ctx context.Context, allProfiles []ProfileResponse, ...) (profile ProfileResponse, err error)

+ type ProfileResolvers map[string]ProfileResolver

+ type ProfileResponse struct

+ EngineType string

+ Id string

+ LatestVersionId string

+ Name string

+ Status string

+ SystemProfile bool

+ Topology string

+ Type string

+ func GetAllProfiles(ctx context.Context, ndbClient *ndb_client.NDBClient) (profiles []ProfileResponse, err error)

+ type Property struct

+ Description string

+ Name string

+ Value string

+ type SLAResponse struct

+ DailyRetention int

+ Description string

+ Id string

+ MonthlyRetention int

+ Name string

+ QuarterlyRetention int

+ UniqueName string

+ WeeklyRetention int

+ YearlyRetention int

+ func GetAllSLAs(ctx context.Context, ndbClient *ndb_client.NDBClient) (slas []SLAResponse, err error)

+ func GetNoneTimeMachineSLA(ctx context.Context, ndb_client *ndb_client.NDBClient) (sla SLAResponse, err error)

+ type TaskInfoSummaryResponse struct

+ AssociatedOperations []TaskInfoSummaryResponse

+ DbServerId string

+ DependencyReport interface{}

+ EntityId string

+ EntityName string

+ EntityType string

+ Message string

+ Name string

+ OperationId string

+ Status string

+ WorkId string

+ func DeprovisionDatabase(ctx context.Context, ndbClient *ndb_client.NDBClient, id string, ...) (task TaskInfoSummaryResponse, err error)

+ func DeprovisionDatabaseServer(ctx context.Context, ndbClient *ndb_client.NDBClient, id string, ...) (task TaskInfoSummaryResponse, err error)

+ func ProvisionDatabase(ctx context.Context, ndbClient *ndb_client.NDBClient, ...) (task TaskInfoSummaryResponse, err error)

+ type TimeMachineInfo struct

+ AutoTuneLogDrive bool

+ Description string

+ Name string

+ Schedule map[string]string

+ SlaId string

+ Tags []string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL