azcosmos

package module

Go to main page

Versions in this module

v1

v1.3.0

Feb 11, 2025

Changes in this version

type QueryOptions

+ EnableCrossPartitionQuery *bool

v1.2.0

Nov 12, 2024

Changes in this version

type PartitionKey

+ func NewPartitionKey() PartitionKey

+ func (pk PartitionKey) AppendBool(value bool) PartitionKey

+ func (pk PartitionKey) AppendNull() PartitionKey

+ func (pk PartitionKey) AppendNumber(value float64) PartitionKey

+ func (pk PartitionKey) AppendString(value string) PartitionKey

type PartitionKeyDefinition

+ Kind PartitionKeyKind

+ func (pkd PartitionKeyDefinition) MarshalJSON() ([]byte, error)

+ type PartitionKeyKind string

+ const PartitionKeyKindHash

+ const PartitionKeyKindMultiHash

v1.1.0

Sep 10, 2024

Changes in this version

+ type DedicatedGatewayRequestOptions struct

+ MaxIntegratedCacheStaleness *time.Duration

type ItemOptions

+ DedicatedGatewayRequestOptions *DedicatedGatewayRequestOptions

type QueryOptions

+ DedicatedGatewayRequestOptions *DedicatedGatewayRequestOptions

v1.0.3

Jun 17, 2024

v1.0.2

Jun 11, 2024

v1.0.1

May 2, 2024

v1.0.0

Apr 9, 2024

Changes in this version

type ClientOptions

+ PreferredRegions []string

v0

v0.3.6

Aug 18, 2023

v0.3.5

May 9, 2023

v0.3.4

Apr 11, 2023

Changes in this version

type PartitionKey

+ var NullPartitionKey PartitionKey = PartitionKey{}

v0.3.3

Jan 10, 2023

Changes in this version

type Client

+ func (c *Client) NewQueryDatabasesPager(query string, o *QueryDatabasesOptions) *runtime.Pager[QueryDatabasesResponse]

type ContainerClient

+ func (c *ContainerClient) PatchItem(ctx context.Context, partitionKey PartitionKey, itemId string, ...) (ItemResponse, error)

type DatabaseClient

+ func (c *DatabaseClient) NewQueryContainersPager(query string, o *QueryContainersOptions) *runtime.Pager[QueryContainersResponse]

+ type PatchOperations struct

+ func (o PatchOperations) MarshalJSON() ([]byte, error)

+ func (p *PatchOperations) AppendAdd(path string, value any)

+ func (p *PatchOperations) AppendIncrement(path string, value int64)

+ func (p *PatchOperations) AppendRemove(path string)

+ func (p *PatchOperations) AppendReplace(path string, value any)

+ func (p *PatchOperations) AppendSet(path string, value any)

+ func (p *PatchOperations) SetCondition(condition string)

+ type QueryContainersOptions struct

+ ContinuationToken string

+ QueryParameters []QueryParameter

+ type QueryContainersResponse struct

+ Containers []ContainerProperties

+ ContinuationToken string

+ type QueryDatabasesOptions struct

+ ContinuationToken string

+ QueryParameters []QueryParameter

+ type QueryDatabasesResponse struct

+ ContinuationToken string

+ Databases []DatabaseProperties

type TransactionalBatch

+ func (b *TransactionalBatch) PatchItem(itemID string, p PatchOperations, o *TransactionalBatchItemOptions)

v0.3.2

Aug 9, 2022

Changes in this version

type Client

+ func NewClientFromConnectionString(connectionString string, o *ClientOptions) (*Client, error)

type QueryOptions

+ QueryParameters []QueryParameter

+ type QueryParameter struct

+ Name string

+ Value any

v0.3.1

May 12, 2022

Changes in this version

type ContainerClient

+ func (c *ContainerClient) ExecuteTransactionalBatch(ctx context.Context, b TransactionalBatch, o *TransactionalBatchOptions) (TransactionalBatchResponse, error)

+ func (c *ContainerClient) NewTransactionalBatch(partitionKey PartitionKey) TransactionalBatch

+ type TransactionalBatch struct

+ func (b *TransactionalBatch) CreateItem(item []byte, o *TransactionalBatchItemOptions)

+ func (b *TransactionalBatch) DeleteItem(itemID string, o *TransactionalBatchItemOptions)

+ func (b *TransactionalBatch) ReadItem(itemID string, o *TransactionalBatchItemOptions)

+ func (b *TransactionalBatch) ReplaceItem(itemID string, item []byte, o *TransactionalBatchItemOptions)

+ func (b *TransactionalBatch) UpsertItem(item []byte, o *TransactionalBatchItemOptions)

+ type TransactionalBatchItemOptions struct

+ IfMatchETag *azcore.ETag

+ type TransactionalBatchOptions struct

+ ConsistencyLevel *ConsistencyLevel

+ EnableContentResponseOnWrite bool

+ SessionToken string

+ type TransactionalBatchResponse struct

+ OperationResults []TransactionalBatchResult

+ SessionToken string

+ Success bool

+ type TransactionalBatchResult struct

+ ETag azcore.ETag

+ RequestCharge float32

+ ResourceBody []byte

+ StatusCode int32

+ func (or *TransactionalBatchResult) UnmarshalJSON(b []byte) error

v0.3.0

May 10, 2022

Changes in this version

type Client

+ func NewClient(endpoint string, cred azcore.TokenCredential, o *ClientOptions) (*Client, error)

type ContainerClient

+ func (c *ContainerClient) NewQueryItemsPager(query string, partitionKey PartitionKey, o *QueryOptions) *runtime.Pager[QueryItemsResponse]

+ type QueryItemsResponse struct

+ ContinuationToken string

+ IndexMetrics *string

+ Items [][]byte

+ QueryMetrics *string

+ type QueryOptions struct

+ ConsistencyLevel *ConsistencyLevel

+ ContinuationToken string

+ EnableScanInQuery bool

+ PageSizeHint int32

+ PopulateIndexMetrics bool

+ ResponseContinuationTokenLimitInKB int32

+ SessionToken string

v0.2.0

Jan 13, 2022

v0.1.0

Nov 10, 2021

Changes in this version

+ type Client struct

+ func NewClientWithKey(endpoint string, cred KeyCredential, o *ClientOptions) (*Client, error)

+ func (c *Client) CreateDatabase(ctx context.Context, databaseProperties DatabaseProperties, ...) (DatabaseResponse, error)

+ func (c *Client) Endpoint() string

+ func (c *Client) NewContainer(databaseId string, containerId string) (*ContainerClient, error)

+ func (c *Client) NewDatabase(id string) (*DatabaseClient, error)

+ type ClientOptions struct

+ EnableContentResponseOnWrite bool

+ type CompositeIndex struct

+ Order CompositeIndexOrder

+ Path string

+ type CompositeIndexOrder string

+ const CompositeIndexAscending

+ const CompositeIndexDescending

+ func CompositeIndexOrderValues() []CompositeIndexOrder

+ func (c CompositeIndexOrder) ToPtr() *CompositeIndexOrder

+ type ConflictResolutionMode string

+ const ConflictResolutionModeCustom

+ const ConflictResolutionModeLastWriteWins

+ func ConflictResolutionModeValues() []ConflictResolutionMode

+ func (c ConflictResolutionMode) ToPtr() *ConflictResolutionMode

+ type ConflictResolutionPolicy struct

+ Mode ConflictResolutionMode

+ ResolutionPath string

+ ResolutionProcedure string

+ type ConsistencyLevel string

+ const ConsistencyLevelBoundedStaleness

+ const ConsistencyLevelConsistentPrefix

+ const ConsistencyLevelEventual

+ const ConsistencyLevelSession

+ const ConsistencyLevelStrong

+ func ConsistencyLevelValues() []ConsistencyLevel

+ func (c ConsistencyLevel) ToPtr() *ConsistencyLevel

+ type ContainerClient struct

+ func (c *ContainerClient) CreateItem(ctx context.Context, partitionKey PartitionKey, item []byte, o *ItemOptions) (ItemResponse, error)

+ func (c *ContainerClient) Delete(ctx context.Context, o *DeleteContainerOptions) (ContainerResponse, error)

+ func (c *ContainerClient) DeleteItem(ctx context.Context, partitionKey PartitionKey, itemId string, o *ItemOptions) (ItemResponse, error)

+ func (c *ContainerClient) ID() string

+ func (c *ContainerClient) Read(ctx context.Context, o *ReadContainerOptions) (ContainerResponse, error)

+ func (c *ContainerClient) ReadItem(ctx context.Context, partitionKey PartitionKey, itemId string, o *ItemOptions) (ItemResponse, error)

+ func (c *ContainerClient) ReadThroughput(ctx context.Context, o *ThroughputOptions) (ThroughputResponse, error)

+ func (c *ContainerClient) Replace(ctx context.Context, containerProperties ContainerProperties, ...) (ContainerResponse, error)

+ func (c *ContainerClient) ReplaceItem(ctx context.Context, partitionKey PartitionKey, itemId string, item []byte, ...) (ItemResponse, error)

+ func (c *ContainerClient) ReplaceThroughput(ctx context.Context, throughputProperties ThroughputProperties, ...) (ThroughputResponse, error)

+ func (c *ContainerClient) UpsertItem(ctx context.Context, partitionKey PartitionKey, item []byte, o *ItemOptions) (ItemResponse, error)

+ type ContainerProperties struct

+ AnalyticalStoreTimeToLiveInSeconds *int32

+ ConflictResolutionPolicy *ConflictResolutionPolicy

+ DefaultTimeToLive *int32

+ ETag *azcore.ETag

+ ID string

+ IndexingPolicy *IndexingPolicy

+ LastModified time.Time

+ PartitionKeyDefinition PartitionKeyDefinition

+ ResourceID string

+ SelfLink string

+ UniqueKeyPolicy *UniqueKeyPolicy

+ func (tp *ContainerProperties) UnmarshalJSON(b []byte) error

+ func (tp ContainerProperties) MarshalJSON() ([]byte, error)

+ type ContainerResponse struct

+ ContainerProperties *ContainerProperties

+ type CreateContainerOptions struct

+ ThroughputProperties *ThroughputProperties

+ type CreateDatabaseOptions struct

+ ThroughputProperties *ThroughputProperties

+ type DataType string

+ const DataTypeLineString

+ const DataTypeMultiPolygon

+ const DataTypeNumber

+ const DataTypePoint

+ const DataTypePolygon

+ const DataTypeString

+ func DataTypeValues() []DataType

+ func (c DataType) ToPtr() *DataType

+ type DatabaseClient struct

+ func (db *DatabaseClient) CreateContainer(ctx context.Context, containerProperties ContainerProperties, ...) (ContainerResponse, error)

+ func (db *DatabaseClient) Delete(ctx context.Context, o *DeleteDatabaseOptions) (DatabaseResponse, error)

+ func (db *DatabaseClient) ID() string

+ func (db *DatabaseClient) NewContainer(id string) (*ContainerClient, error)

+ func (db *DatabaseClient) Read(ctx context.Context, o *ReadDatabaseOptions) (DatabaseResponse, error)

+ func (db *DatabaseClient) ReadThroughput(ctx context.Context, o *ThroughputOptions) (ThroughputResponse, error)

+ func (db *DatabaseClient) ReplaceThroughput(ctx context.Context, throughputProperties ThroughputProperties, ...) (ThroughputResponse, error)

+ type DatabaseProperties struct

+ ETag *azcore.ETag

+ ID string

+ LastModified time.Time

+ ResourceID string

+ SelfLink string

+ func (tp *DatabaseProperties) UnmarshalJSON(b []byte) error

+ func (tp DatabaseProperties) MarshalJSON() ([]byte, error)

+ type DatabaseResponse struct

+ DatabaseProperties *DatabaseProperties

+ type DeleteContainerOptions struct

+ type DeleteDatabaseOptions struct

+ IfMatchEtag *azcore.ETag

+ IfNoneMatchEtag *azcore.ETag

+ type ExcludedPath struct

+ Path string

+ type IncludedPath struct

+ Path string

+ type IndexingDirective string

+ const IndexingDirectiveDefault

+ const IndexingDirectiveExclude

+ const IndexingDirectiveInclude

+ func IndexingDirectives() []IndexingDirective

+ func (c IndexingDirective) ToPtr() *IndexingDirective

+ type IndexingMode string

+ const IndexingModeConsistent

+ const IndexingModeNone

+ func IndexingModeValues() []IndexingMode

+ func (c IndexingMode) ToPtr() *IndexingMode

+ type IndexingPolicy struct

+ Automatic bool

+ CompositeIndexes [][]CompositeIndex

+ ExcludedPaths []ExcludedPath

+ IncludedPaths []IncludedPath

+ IndexingMode IndexingMode

+ SpatialIndexes []SpatialIndex

+ type ItemOptions struct

+ ConsistencyLevel *ConsistencyLevel

+ EnableContentResponseOnWrite bool

+ IfMatchEtag *azcore.ETag

+ IndexingDirective *IndexingDirective

+ PostTriggers []string

+ PreTriggers []string

+ SessionToken string

+ type ItemResponse struct

+ SessionToken string

+ Value []byte

+ type KeyCredential struct

+ func NewKeyCredential(accountKey string) (KeyCredential, error)

+ func (c *KeyCredential) Update(accountKey string) error

+ type PartitionKey struct

+ func NewPartitionKeyBool(value bool) PartitionKey

+ func NewPartitionKeyNumber(value float64) PartitionKey

+ func NewPartitionKeyString(value string) PartitionKey

+ type PartitionKeyDefinition struct

+ Paths []string

+ Version int

+ type ReadContainerOptions struct

+ PopulateQuotaInfo bool

+ type ReadDatabaseOptions struct

+ IfMatchEtag *azcore.ETag

+ IfNoneMatchEtag *azcore.ETag

+ type ReplaceContainerOptions struct

+ type Response struct

+ ActivityID string

+ ETag azcore.ETag

+ RawResponse *http.Response

+ RequestCharge float32

+ type SpatialIndex struct

+ Path string

+ SpatialTypes []SpatialType

+ type SpatialType string

+ const SpatialTypeLineString

+ const SpatialTypeMultiPolygon

+ const SpatialTypePoint

+ const SpatialTypePolygon

+ func SpatialTypeValues() []SpatialType

+ func (c SpatialType) ToPtr() *SpatialType

+ type ThroughputOptions struct

+ IfMatchEtag *azcore.ETag

+ IfNoneMatchEtag *azcore.ETag

+ type ThroughputProperties struct

+ ETag *azcore.ETag

+ LastModified time.Time

+ func NewAutoscaleThroughputProperties(startingMaxThroughput int32) ThroughputProperties

+ func NewAutoscaleThroughputPropertiesWithIncrement(startingMaxThroughput int32, incrementPercentage int32) ThroughputProperties

+ func NewManualThroughputProperties(throughput int32) ThroughputProperties

+ func (tp *ThroughputProperties) AutoscaleIncrement() (int32, bool)

+ func (tp *ThroughputProperties) AutoscaleMaxThroughput() (int32, bool)

+ func (tp *ThroughputProperties) ManualThroughput() (int32, bool)

+ func (tp *ThroughputProperties) MarshalJSON() ([]byte, error)

+ func (tp *ThroughputProperties) UnmarshalJSON(b []byte) error

+ type ThroughputResponse struct

+ IsReplacePending bool

+ MinThroughput *int32

+ ThroughputProperties *ThroughputProperties

+ type UniqueKey struct

+ Paths []string

+ type UniqueKeyPolicy struct

+ UniqueKeys []UniqueKey

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