azure_cosmosdb_debug library

Azure CosmosDB SQL Rest API for Dart/Flutter.

Classes

BaseDocument
Base class for CosmosDB documents.
BaseDocumentWithEtag
Base class for CosmosDB documents including the etag property.
Batch
Base class for a transactional batch.
BatchOperation
Base class for batch operations.
BatchOperationCreate<T extends BaseDocument>
Batch operation for adding a document in the target container.
BatchOperationDelete
Batch operation for deleting a document from the target container.
BatchOperationOnItem<T extends BaseDocument>
Base class for batch operations on specific items, e.g. BatchOperationCreate.
BatchOperationOnType<T extends BaseDocument>
Base class for batch operations on specific document types, e.g. BatchOperationRead.
BatchOperationPatch<T extends BaseDocument>
Batch operation for patching documents in the target container.
BatchOperationRead<T extends BaseDocument>
Batch operation for loading a document from the target container.
BatchOperationReplace<T extends BaseDocument>
Batch operation for replacing a document in the target container.
BatchOperationResult<T extends BaseDocument>
Class representing a BatchOperation's result.
BatchOperationType
Constants for batch operation types.
BatchOperationUpsert<T extends BaseDocument>
Batch operation for upserting a document in the target container.
BatchResponse
Class containing the results of a batch transaction.
BoundingBox
Class representing a bounding box for spatial indexing.
CosmosDbContainer
Class representing a CosmosDB container.
CosmosDbContainers
Class used to manage CosmosDbContainers in a CosmosDbDatabase.
CosmosDbDatabase
Class representing a CosmosDB database.
CosmosDbDatabases
Class used to manage CosmosDbDatabases in a CosmosDbServer.
CosmosDbPermission
Class representing a CosmosDB permission.
CosmosDbPermissions
Class used to manage CosmosDbPermissions for CosmosDB CosmosDbUsers.
CosmosDbServer
Class representing a CosmosDB instance.
CosmosDbThroughput
Class representing a CosmosDB throughput.
CosmosDbUser
Class representing a CosmosDB user.
CosmosDbUsers
Class used to manage CosmosDbUsers in a CosmosDB CosmosDbDatabase.
CrossPartitionBatch
A cross-partition transactional batch. This class can handle operations targetting multiple partition keys, and supports more than 100 operations. Atomic behavior is not possible with this class, and isAtomic will always be false. Stopping on error is also not possible with this implementation and continueOnError will always be true.
DataType
Constants for data types.
DebugHttpClient
Debug HTTP client that can be used to trace request/responses. This client also installs a global HTTP override object to accept self-signed certificates. DO NOT USE IN PRODUCTION.
DistanceCalculator
Base class for distance calculation algorithms.
DistanceCalculator2D
Euclidean distance calculator for points in a 2D plane (X/Y coordinates).
DistanceCalculator3D
Euclidean distance calculator for points in a 3D space (X/Y/Z coordinates).
DistanceCalculatorHaversine
Distance calculator for points on a sphere (latitude/longitude coordinates), based on the Haversine algorithm.
Features
Class representing the features supported by a Cosmos DB client.
GeospatialConfig
Constants for geo spatial config.
HttpStatusCode
Constants for HTTP status codes.
IndexingMode
Constants for indexing modes.
IndexingPolicy
Class representing a container's indexing policy.
IndexOrder
Constants for index ordering.
IndexPath
Class representing an index.
LineString
Class representing a line.
MultiPolygon
Class representing a list of polygons.
Paging
Class used for pagination.
PartitionKey
Class representing a partition key.
PartitionKeyRange
Class representing a partition key range.
PartitionKeySpec
Class representing a partition key definition in a Cosmos DB container.
Patch
Class representing a series of operations to modify a document.
PatchOperation
Class representing a patch operation.
PatchOperationType
Constants for patch operations.
PermissionMode
Constants for permission modes.
Point
Class represengin a position.
Polygon
Class represengin a polygon
Query
Class representing CosmosDB SQL query.
RetryOptions
Object holding options for retrying a function.
Shape
Base class for shapes.
SpatialIndexPath
Class representing a spatial index.
TransactionalBatch
Class representing a transactional batch. This implementation provides atomic and non-atomic transactions. Atomic transactions will always fail on error, and support a maximum of 100 operations per batch. For non-atomic transactions, the behavior in case of error can be controlled via the continueOnError flag. Non-atomic transactions send operations in chunks of 100, effectively working around the Cosmos DB limitation of 100 operations per batch.

Mixins

EtagMixin
Base class for CosmosDB documents including the etag property.

Constants

currentApiVersion → const String
earthDistanceCalculator → const DistanceCalculatorHaversine
Distance calculator for points in latitude/longitude coordinates on Earth.
earthRadiusInKm → const double
The Earth's radius, in kilometers.
previewApiVersion → const String

Typedefs

DocumentBuilder<T extends BaseDocument> = T Function(Map json)
Function definition to hydrate (deserialize) CosmosDB documents.
FutureCallback<T> = Future<T> Function()
ShapeLoader = Shape Function(Iterable geoJson)