manageddatabasetables

package
v0.20240315.1103122 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 15, 2024 License: MPL-2.0 Imports: 10 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/sql/2023-05-01-preview/manageddatabasetables Documentation

The manageddatabasetables SDK allows for interaction with the Azure Resource Manager Service sql (API Version 2023-05-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/2023-05-01-preview/manageddatabasetables"

Client Initialization

client := manageddatabasetables.NewManagedDatabaseTablesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ManagedDatabaseTablesClient.Get

ctx := context.TODO()
id := manageddatabasetables.NewSchemaTableID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedInstanceValue", "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: ManagedDatabaseTablesClient.ListBySchema

ctx := context.TODO()
id := manageddatabasetables.NewDatabaseSchemaID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedInstanceValue", "databaseValue", "schemaValue")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForTableTemporalType

func PossibleValuesForTableTemporalType() []string

func ValidateDatabaseSchemaID

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

ValidateDatabaseSchemaID checks that 'input' can be parsed as a Database Schema ID

func ValidateSchemaTableID

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

ValidateSchemaTableID checks that 'input' can be parsed as a Schema Table ID

Types

type DatabaseSchemaId

type DatabaseSchemaId struct {
	SubscriptionId      string
	ResourceGroupName   string
	ManagedInstanceName string
	DatabaseName        string
	SchemaName          string
}

DatabaseSchemaId is a struct representing the Resource ID for a Database Schema

func NewDatabaseSchemaID

func NewDatabaseSchemaID(subscriptionId string, resourceGroupName string, managedInstanceName string, databaseName string, schemaName string) DatabaseSchemaId

NewDatabaseSchemaID returns a new DatabaseSchemaId struct

func ParseDatabaseSchemaID

func ParseDatabaseSchemaID(input string) (*DatabaseSchemaId, error)

ParseDatabaseSchemaID parses 'input' into a DatabaseSchemaId

func ParseDatabaseSchemaIDInsensitively

func ParseDatabaseSchemaIDInsensitively(input string) (*DatabaseSchemaId, error)

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

func (*DatabaseSchemaId) FromParseResult

func (id *DatabaseSchemaId) FromParseResult(input resourceids.ParseResult) error

func (DatabaseSchemaId) ID

func (id DatabaseSchemaId) ID() string

ID returns the formatted Database Schema ID

func (DatabaseSchemaId) Segments

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

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

func (DatabaseSchemaId) String

func (id DatabaseSchemaId) String() string

String returns a human-readable description of this Database Schema ID

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

type DatabaseTableProperties

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

type GetOperationResponse

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

type ListBySchemaCompleteResult

type ListBySchemaCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DatabaseTable
}

type ListBySchemaOperationOptions

type ListBySchemaOperationOptions struct {
	Filter *string
}

func DefaultListBySchemaOperationOptions

func DefaultListBySchemaOperationOptions() ListBySchemaOperationOptions

func (ListBySchemaOperationOptions) ToHeaders

func (ListBySchemaOperationOptions) ToOData

func (ListBySchemaOperationOptions) ToQuery

type ListBySchemaOperationResponse

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

type ManagedDatabaseTablesClient

type ManagedDatabaseTablesClient struct {
	Client *resourcemanager.Client
}

func NewManagedDatabaseTablesClientWithBaseURI

func NewManagedDatabaseTablesClientWithBaseURI(sdkApi sdkEnv.Api) (*ManagedDatabaseTablesClient, error)

func (ManagedDatabaseTablesClient) Get

Get ...

func (ManagedDatabaseTablesClient) ListBySchema

ListBySchema ...

func (ManagedDatabaseTablesClient) ListBySchemaComplete

ListBySchemaComplete retrieves all the results into a single object

func (ManagedDatabaseTablesClient) ListBySchemaCompleteMatchingPredicate

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

ListBySchemaCompleteMatchingPredicate retrieves all the results and then applies the predicate

type SchemaTableId

type SchemaTableId struct {
	SubscriptionId      string
	ResourceGroupName   string
	ManagedInstanceName string
	DatabaseName        string
	SchemaName          string
	TableName           string
}

SchemaTableId is a struct representing the Resource ID for a Schema Table

func NewSchemaTableID

func NewSchemaTableID(subscriptionId string, resourceGroupName string, managedInstanceName string, databaseName string, schemaName string, tableName string) SchemaTableId

NewSchemaTableID returns a new SchemaTableId struct

func ParseSchemaTableID

func ParseSchemaTableID(input string) (*SchemaTableId, error)

ParseSchemaTableID parses 'input' into a SchemaTableId

func ParseSchemaTableIDInsensitively

func ParseSchemaTableIDInsensitively(input string) (*SchemaTableId, error)

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

func (*SchemaTableId) FromParseResult

func (id *SchemaTableId) FromParseResult(input resourceids.ParseResult) error

func (SchemaTableId) ID

func (id SchemaTableId) ID() string

ID returns the formatted Schema Table ID

func (SchemaTableId) Segments

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

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

func (SchemaTableId) String

func (id SchemaTableId) String() string

String returns a human-readable description of this Schema 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

Jump to

Keyboard shortcuts

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