databasetables

README

github.com/hashicorp/go-azure-sdk/resource-manager/sql/2021-02-01-preview/databasetables Documentation

The databasetables SDK allows for interaction with the Azure Resource Manager Service sql (API Version 2021-02-01-preview).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/sql/2021-02-01-preview/databasetables"

Client Initialization

client := databasetables.NewDatabaseTablesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DatabaseTablesClient.Get

ctx := context.TODO()
id := databasetables.NewTableID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "databaseValue", "schemaValue", "tableValue")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DatabaseTablesClient.ListBySchema

ctx := context.TODO()
id := databasetables.NewSchemaID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "databaseValue", "schemaValue")

// alternatively `client.ListBySchema(ctx, id, databasetables.DefaultListBySchemaOperationOptions())` can be used to do batched pagination
items, err := client.ListBySchemaComplete(ctx, id, databasetables.DefaultListBySchemaOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

• func PossibleValuesForTableTemporalType() []string
• func ValidateSchemaID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateTableID(input interface{}, key string) (warnings []string, errors []error)
• type DatabaseTable
• type DatabaseTableOperationPredicate
  • func (p DatabaseTableOperationPredicate) Matches(input DatabaseTable) bool
• type DatabaseTableProperties
• type DatabaseTablesClient
  • func NewDatabaseTablesClientWithBaseURI(sdkApi sdkEnv.Api) (*DatabaseTablesClient, error)
  • func (c DatabaseTablesClient) Get(ctx context.Context, id TableId) (result GetOperationResponse, err error)
  • func (c DatabaseTablesClient) ListBySchema(ctx context.Context, id SchemaId, options ListBySchemaOperationOptions) (result ListBySchemaOperationResponse, err error)
  • func (c DatabaseTablesClient) ListBySchemaComplete(ctx context.Context, id SchemaId, options ListBySchemaOperationOptions) (ListBySchemaCompleteResult, error)
  • func (c DatabaseTablesClient) ListBySchemaCompleteMatchingPredicate(ctx context.Context, id SchemaId, options ListBySchemaOperationOptions, ...) (result ListBySchemaCompleteResult, err error)
• type GetOperationResponse
• type ListBySchemaCompleteResult
• type ListBySchemaOperationOptions
  • func DefaultListBySchemaOperationOptions() ListBySchemaOperationOptions
  • func (o ListBySchemaOperationOptions) ToHeaders() *client.Headers
  • func (o ListBySchemaOperationOptions) ToOData() *odata.Query
  • func (o ListBySchemaOperationOptions) ToQuery() *client.QueryParams
• type ListBySchemaOperationResponse
• type SchemaId
  • func NewSchemaID(subscriptionId string, resourceGroupName string, serverName string, ...) SchemaId
  • func ParseSchemaID(input string) (*SchemaId, error)
  • func ParseSchemaIDInsensitively(input string) (*SchemaId, error)
  • func (id SchemaId) ID() string
  • func (id SchemaId) Segments() []resourceids.Segment
  • func (id SchemaId) String() string
• type TableId
  • func NewTableID(subscriptionId string, resourceGroupName string, serverName string, ...) TableId
  • func ParseTableID(input string) (*TableId, error)
  • func ParseTableIDInsensitively(input string) (*TableId, error)
  • func (id TableId) ID() string
  • func (id TableId) Segments() []resourceids.Segment
  • func (id TableId) String() string
• type TableTemporalType
  • func (s *TableTemporalType) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForTableTemporalType

func PossibleValuesForTableTemporalType() []string

func ValidateSchemaID

func ValidateSchemaID(input interface{}, key string) (warnings []string, errors []error)

ValidateSchemaID checks that 'input' can be parsed as a Schema ID

func ValidateTableID

func ValidateTableID(input interface{}, key string) (warnings []string, errors []error)

ValidateTableID checks that 'input' can be parsed as a Table ID

Types

type DatabaseTable

type DatabaseTable struct {
	Id         *string                  `json:"id,omitempty"`
	Name       *string                  `json:"name,omitempty"`
	Properties *DatabaseTableProperties `json:"properties,omitempty"`
	Type       *string                  `json:"type,omitempty"`
}

type DatabaseTableOperationPredicate

type DatabaseTableOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (DatabaseTableOperationPredicate) Matches

func (p DatabaseTableOperationPredicate) Matches(input DatabaseTable) bool

type DatabaseTableProperties

type DatabaseTableProperties struct {
	MemoryOptimized *bool              `json:"memoryOptimized,omitempty"`
	TemporalType    *TableTemporalType `json:"temporalType,omitempty"`
}

type DatabaseTablesClient

type DatabaseTablesClient struct {
	Client *resourcemanager.Client
}

func NewDatabaseTablesClientWithBaseURI

func NewDatabaseTablesClientWithBaseURI(sdkApi sdkEnv.Api) (*DatabaseTablesClient, error)

func (DatabaseTablesClient) Get

func (c DatabaseTablesClient) Get(ctx context.Context, id TableId) (result GetOperationResponse, err error)

Get ...

func (DatabaseTablesClient) ListBySchema

func (c DatabaseTablesClient) ListBySchema(ctx context.Context, id SchemaId, options ListBySchemaOperationOptions) (result ListBySchemaOperationResponse, err error)

ListBySchema ...

func (DatabaseTablesClient) ListBySchemaComplete

func (c DatabaseTablesClient) ListBySchemaComplete(ctx context.Context, id SchemaId, options ListBySchemaOperationOptions) (ListBySchemaCompleteResult, error)

ListBySchemaComplete retrieves all the results into a single object

func (DatabaseTablesClient) ListBySchemaCompleteMatchingPredicate

func (c DatabaseTablesClient) ListBySchemaCompleteMatchingPredicate(ctx context.Context, id SchemaId, options ListBySchemaOperationOptions, predicate DatabaseTableOperationPredicate) (result ListBySchemaCompleteResult, err error)

ListBySchemaCompleteMatchingPredicate retrieves all the results and then applies the predicate

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DatabaseTable
}

type ListBySchemaCompleteResult

type ListBySchemaCompleteResult struct {
	Items []DatabaseTable
}

type ListBySchemaOperationOptions

type ListBySchemaOperationOptions struct {
	Filter *string
}

func DefaultListBySchemaOperationOptions

func DefaultListBySchemaOperationOptions() ListBySchemaOperationOptions

func (ListBySchemaOperationOptions) ToHeaders

func (o ListBySchemaOperationOptions) ToHeaders() *client.Headers

func (ListBySchemaOperationOptions) ToOData

func (o ListBySchemaOperationOptions) ToOData() *odata.Query

func (ListBySchemaOperationOptions) ToQuery

func (o ListBySchemaOperationOptions) ToQuery() *client.QueryParams

type ListBySchemaOperationResponse

type ListBySchemaOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DatabaseTable
}

type SchemaId

type SchemaId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServerName        string
	DatabaseName      string
	SchemaName        string
}

SchemaId is a struct representing the Resource ID for a Schema

func NewSchemaID

func NewSchemaID(subscriptionId string, resourceGroupName string, serverName string, databaseName string, schemaName string) SchemaId

NewSchemaID returns a new SchemaId struct

func ParseSchemaID

func ParseSchemaID(input string) (*SchemaId, error)

ParseSchemaID parses 'input' into a SchemaId

func ParseSchemaIDInsensitively

func ParseSchemaIDInsensitively(input string) (*SchemaId, error)

ParseSchemaIDInsensitively parses 'input' case-insensitively into a SchemaId note: this method should only be used for API response data and not user input

func (SchemaId) ID

func (id SchemaId) ID() string

ID returns the formatted Schema ID

func (SchemaId) Segments

func (id SchemaId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Schema ID

func (SchemaId) String

func (id SchemaId) String() string

String returns a human-readable description of this Schema ID

type TableId

type TableId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServerName        string
	DatabaseName      string
	SchemaName        string
	TableName         string
}

TableId is a struct representing the Resource ID for a Table

func NewTableID

func NewTableID(subscriptionId string, resourceGroupName string, serverName string, databaseName string, schemaName string, tableName string) TableId

NewTableID returns a new TableId struct

func ParseTableID

func ParseTableID(input string) (*TableId, error)

ParseTableID parses 'input' into a TableId

func ParseTableIDInsensitively

func ParseTableIDInsensitively(input string) (*TableId, error)

ParseTableIDInsensitively parses 'input' case-insensitively into a TableId note: this method should only be used for API response data and not user input

func (TableId) ID

func (id TableId) ID() string

ID returns the formatted Table ID

func (TableId) Segments

func (id TableId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Table ID

func (TableId) String

func (id TableId) String() string

String returns a human-readable description of this Table ID

type TableTemporalType

type TableTemporalType string

const (
	TableTemporalTypeHistoryTable                 TableTemporalType = "HistoryTable"
	TableTemporalTypeNonTemporalTable             TableTemporalType = "NonTemporalTable"
	TableTemporalTypeSystemVersionedTemporalTable TableTemporalType = "SystemVersionedTemporalTable"
)

func (*TableTemporalType) UnmarshalJSON

func (s *TableTemporalType) UnmarshalJSON(bytes []byte) error