manageddatabasecolumns

package
v0.20240123.1101251 Latest Latest
Warning

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

Go to latest
Published: Jan 23, 2024 License: MPL-2.0 Imports: 11 Imported by: 0

README

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

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

Client Initialization

client := manageddatabasecolumns.NewManagedDatabaseColumnsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ManagedDatabaseColumnsClient.Get

ctx := context.TODO()
id := manageddatabasecolumns.NewTableColumnID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedInstanceValue", "databaseValue", "schemaValue", "tableValue", "columnValue")

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: ManagedDatabaseColumnsClient.ListByDatabase

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

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

Example Usage: ManagedDatabaseColumnsClient.ListByTable

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

// alternatively `client.ListByTable(ctx, id, manageddatabasecolumns.DefaultListByTableOperationOptions())` can be used to do batched pagination
items, err := client.ListByTableComplete(ctx, id, manageddatabasecolumns.DefaultListByTableOperationOptions())
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 PossibleValuesForColumnDataType

func PossibleValuesForColumnDataType() []string

func PossibleValuesForTableTemporalType

func PossibleValuesForTableTemporalType() []string

func ValidateSchemaTableID

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

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

func ValidateTableColumnID

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

ValidateTableColumnID checks that 'input' can be parsed as a Table Column ID

Types

type ColumnDataType

type ColumnDataType string
const (
	ColumnDataTypeBigint           ColumnDataType = "bigint"
	ColumnDataTypeBinary           ColumnDataType = "binary"
	ColumnDataTypeBit              ColumnDataType = "bit"
	ColumnDataTypeChar             ColumnDataType = "char"
	ColumnDataTypeDate             ColumnDataType = "date"
	ColumnDataTypeDatetime         ColumnDataType = "datetime"
	ColumnDataTypeDatetimeTwo      ColumnDataType = "datetime2"
	ColumnDataTypeDatetimeoffset   ColumnDataType = "datetimeoffset"
	ColumnDataTypeDecimal          ColumnDataType = "decimal"
	ColumnDataTypeFloat            ColumnDataType = "float"
	ColumnDataTypeGeography        ColumnDataType = "geography"
	ColumnDataTypeGeometry         ColumnDataType = "geometry"
	ColumnDataTypeHierarchyid      ColumnDataType = "hierarchyid"
	ColumnDataTypeImage            ColumnDataType = "image"
	ColumnDataTypeInt              ColumnDataType = "int"
	ColumnDataTypeMoney            ColumnDataType = "money"
	ColumnDataTypeNchar            ColumnDataType = "nchar"
	ColumnDataTypeNtext            ColumnDataType = "ntext"
	ColumnDataTypeNumeric          ColumnDataType = "numeric"
	ColumnDataTypeNvarchar         ColumnDataType = "nvarchar"
	ColumnDataTypeReal             ColumnDataType = "real"
	ColumnDataTypeSmalldatetime    ColumnDataType = "smalldatetime"
	ColumnDataTypeSmallint         ColumnDataType = "smallint"
	ColumnDataTypeSmallmoney       ColumnDataType = "smallmoney"
	ColumnDataTypeSqlVariant       ColumnDataType = "sql_variant"
	ColumnDataTypeSysname          ColumnDataType = "sysname"
	ColumnDataTypeText             ColumnDataType = "text"
	ColumnDataTypeTime             ColumnDataType = "time"
	ColumnDataTypeTimestamp        ColumnDataType = "timestamp"
	ColumnDataTypeTinyint          ColumnDataType = "tinyint"
	ColumnDataTypeUniqueidentifier ColumnDataType = "uniqueidentifier"
	ColumnDataTypeVarbinary        ColumnDataType = "varbinary"
	ColumnDataTypeVarchar          ColumnDataType = "varchar"
	ColumnDataTypeXml              ColumnDataType = "xml"
)

func (*ColumnDataType) UnmarshalJSON

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

type DatabaseColumn

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

type DatabaseColumnOperationPredicate

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

func (DatabaseColumnOperationPredicate) Matches

type DatabaseColumnProperties

type DatabaseColumnProperties struct {
	ColumnType      *ColumnDataType    `json:"columnType,omitempty"`
	IsComputed      *bool              `json:"isComputed,omitempty"`
	MemoryOptimized *bool              `json:"memoryOptimized,omitempty"`
	TemporalType    *TableTemporalType `json:"temporalType,omitempty"`
}

type GetOperationResponse

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

type ListByDatabaseCompleteResult

type ListByDatabaseCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DatabaseColumn
}

type ListByDatabaseOperationOptions

type ListByDatabaseOperationOptions struct {
	Column  *[]string
	OrderBy *[]string
	Schema  *[]string
	Table   *[]string
}

func DefaultListByDatabaseOperationOptions

func DefaultListByDatabaseOperationOptions() ListByDatabaseOperationOptions

func (ListByDatabaseOperationOptions) ToHeaders

func (ListByDatabaseOperationOptions) ToOData

func (ListByDatabaseOperationOptions) ToQuery

type ListByDatabaseOperationResponse

type ListByDatabaseOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DatabaseColumn
}

type ListByTableCompleteResult

type ListByTableCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DatabaseColumn
}

type ListByTableOperationOptions

type ListByTableOperationOptions struct {
	Filter *string
}

func DefaultListByTableOperationOptions

func DefaultListByTableOperationOptions() ListByTableOperationOptions

func (ListByTableOperationOptions) ToHeaders

func (ListByTableOperationOptions) ToOData

func (ListByTableOperationOptions) ToQuery

type ListByTableOperationResponse

type ListByTableOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DatabaseColumn
}

type ManagedDatabaseColumnsClient

type ManagedDatabaseColumnsClient struct {
	Client *resourcemanager.Client
}

func NewManagedDatabaseColumnsClientWithBaseURI

func NewManagedDatabaseColumnsClientWithBaseURI(sdkApi sdkEnv.Api) (*ManagedDatabaseColumnsClient, error)

func (ManagedDatabaseColumnsClient) Get

Get ...

func (ManagedDatabaseColumnsClient) ListByDatabase

ListByDatabase ...

func (ManagedDatabaseColumnsClient) ListByDatabaseComplete

ListByDatabaseComplete retrieves all the results into a single object

func (ManagedDatabaseColumnsClient) ListByDatabaseCompleteMatchingPredicate

ListByDatabaseCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ManagedDatabaseColumnsClient) ListByTable

ListByTable ...

func (ManagedDatabaseColumnsClient) ListByTableComplete

ListByTableComplete retrieves all the results into a single object

func (ManagedDatabaseColumnsClient) ListByTableCompleteMatchingPredicate

func (c ManagedDatabaseColumnsClient) ListByTableCompleteMatchingPredicate(ctx context.Context, id SchemaTableId, options ListByTableOperationOptions, predicate DatabaseColumnOperationPredicate) (result ListByTableCompleteResult, err error)

ListByTableCompleteMatchingPredicate 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 added in v0.20231127.1171502

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 TableColumnId

type TableColumnId struct {
	SubscriptionId      string
	ResourceGroupName   string
	ManagedInstanceName string
	DatabaseName        string
	SchemaName          string
	TableName           string
	ColumnName          string
}

TableColumnId is a struct representing the Resource ID for a Table Column

func NewTableColumnID

func NewTableColumnID(subscriptionId string, resourceGroupName string, managedInstanceName string, databaseName string, schemaName string, tableName string, columnName string) TableColumnId

NewTableColumnID returns a new TableColumnId struct

func ParseTableColumnID

func ParseTableColumnID(input string) (*TableColumnId, error)

ParseTableColumnID parses 'input' into a TableColumnId

func ParseTableColumnIDInsensitively

func ParseTableColumnIDInsensitively(input string) (*TableColumnId, error)

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

func (*TableColumnId) FromParseResult added in v0.20231127.1171502

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

func (TableColumnId) ID

func (id TableColumnId) ID() string

ID returns the formatted Table Column ID

func (TableColumnId) Segments

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

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

func (TableColumnId) String

func (id TableColumnId) String() string

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