Categorygithub.com/DSTOLF/delphix-go-sdk
modulepackage
0.0.0-20201007195319-356b1c8e1b0f
Repository: https://github.com/dstolf/delphix-go-sdk.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
11
Dependents
0
Files
1.9k SLOC

# README

Delphix Mini Golang SDK

This is a refactoring of the delphix-go-sdk.

  • There's just the bare minium to work with AppData plugins
  • All tests are self contained (all the objects are created, searched and deleted)
  • Overall, it's simpler to work with.

Right now, it's only going to work with the CSI plugin, but it shouldn't be hard to add other plugins.

Testing

This is just a package, so there's actual build.

Edit testvars.testvars and set environment variables (engine address, username, password, name of the VDBs the tests will create etc).

Tests cases are numbered and executed in order ([0-9][0-9]*_test.go)

To run the tests, just:

source testvars.testvars
go test

# Functions

AppDataProvisionParametersFactory is just a simple function to instantiate the AppDataProvisionParametersStruct.
AppDataRollbackParametersFactory is just a simple function to instantiate the RollbackParametersStruct.
AppDataSyncParametersFactory is just a simple function to instantiate the AppDataSyncParametersStruct.
CreateAPISession returns an APISession objectv = APIVersion Structl = Locale as an IETF BCP 47 language tag, defaults to 'en-US'.c = Client software identification token.
CreateAPIVersion returns an APISession object.
CreateAppDataRollbackParameters is just a simple function to instantiate the RollbackParametersStruct.
CreateAppDataSyncParameters is just a simple function to instantiate the AppDataSyncParametersStruct.
CSIProvisionParametersFactory is just a simple function to instantiate the AppDataProvisionParametersStruct.
NewClient creates a new client object.

# Structs

APIErrorStruct - Description of an error encountered during an API call.
APISessionStruct - Describes a Delphix web service session and is the result of an initial handshake.
APIVersionStruct - Describes an API version.
AppDataAdditionalMountPointStruct - Specifies an additional location on which to mount a subdirectory of an AppData container.
AppDataContainerRuntimeStruct - Runtime properties of an AppData container.
AppDataContainerStruct - Data container for AppData.
AppDataDirectSourceConfigStruct - Source config for directly linked AppData sources.
AppDataProvisionParametersStruct - The parameters to use as input to provision AppData.
AppDataRollbackParametersStruct - The parameters to use as input to rollback requests for AppData.
AppDataSnapshotRuntimeStruct - Runtime (non-persistent) properties of AppData TimeFlow snapshots.
AppDataSnapshotStruct - Snapshot of an AppData TimeFlow.
AppDataSourceConfigStruct - An AppData source config with empty vFiles.
AppDataSourceRuntimeStruct - Runtime (non-persistent) properties of an AppData source.
AppDataSyncParametersStruct - The parameters to use as input to sync an AppData source.
AppDataTimeflowPointParametersStruct - An AppData source config with empty vFiles.
AppDataTimeflowPointStruct - A unique point within an AppData TimeFlow.
AppDataVirtualSourceStruct - A virtual AppData source.
AuthSuccess holds the resty response success message.
Client the structure of a client request.
CSIAppDataProvisionParametersStruct - The parameters to use as input to provision AppData.
CSIAppDataVirtualSourceStruct - A virtual AppData source.
CSIProvisionParametersStruct - The parameters to use as input to provision AppData.
CSISourceConfigParameterStruct - CSI Driver Source Config.
CSISourceConfigStruct - Source config for directly linked AppData sources.
DeleteParametersStruct - The parameters to use as input to delete requests for MSSQL, PostgreSQL, AppData, ASE or MySQL.
DiagnosisResultStruct - Details from a diagnosis check that was run due to a failed operation.
ErrorStruct is the struct of a resty error.
JSONStruct - A dummy schema that is used to represent JSON.
LoginRequestStruct - Represents a Delphix user authentication request.
PreProvisioningRuntimeStruct - Runtime properties for pre-provisioning of a MSSQL database container.
RespError holds the resty response failure message.
SourcingPolicyStruct - Database policies for managing SnapSync and LogSync across sources for a MSSQL container.
VirtualSourceOperationsStruct - Describes operations which are performed on virtual sources at various times.

# Interfaces

AppDataSourceConfig is an empty interface designed to function as the AppDataSourceConfig API namespace.
DatabaseContainer is an empty interface designed to function as the DatabaseContainer API namespace.
SourceOperation is an empty interface designed to function as the SourceOperation API namespace.
TimeflowPoint is an empty interface designed to function as the TimeflowPoint API namespace.
TimeflowPointParameters is an empty interface designed to function as the TimeflowPointParameters API namespace.
TimeflowSnapshot is an empty interface designed to function as the TimeflowSnapshot API namespace.