azure_cosmosdb 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. - BoundingBox
- Class representing a bounding box for spatial indexing.
- CosmosDbCollection
- Class representing a CosmosDB collection.
- CosmosDbCollections
- Class used to manage CosmosDbCollections in a CosmosDbDatabase.
- CosmosDbDatabase
- Class representing a CosmosDB database.
- CosmosDbDatabases
- Class used to manage CosmosDbDatabases in a CosmosDbServer.
- CosmosDbPartition
- Class representing a partition in a Cosmos DB collection.
- 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.
- DataType
- Constants for data types.
- DistanceCalculator
- DistanceCalculator2D
- DistanceCalculator3D
- DistanceCalculatorHaversine
- GeospatialConfig
- Constants for geo spatial config.
- IndexingMode
- Constants for indexing modes.
- IndexingPolicy
- Class representing a collections'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.
- Patch
- PermissionMode
- Permission modes
- Point
- Class represengin a position
- 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.
Mixins
- EtagMixin
-
Base class for CosmosDB documents including the
etag
property. - PartitionKeyMixin
- Mixin to add custom partition key on BaseDocument.
Extensions
Constants
- earthDistanceCalculator → const DistanceCalculatorHaversine
- earthRadiusInKm → const double
Typedefs
- Collections = CosmosDbCollections
- Databases = CosmosDbDatabases
-
DocumentBuilder<
T extends BaseDocument> = T Function(Map json) - Function definition to hydrate (deserialize) CosmosDB documents.
- Partition = CosmosDbPartition
- Permission = CosmosDbPermission
- ShapeLoader = Shape Function(Iterable geoJson)
- User = CosmosDbUser
Exceptions / Errors
- ApplicationException
- BadResponseException
- ConflictException
- ContextualizedException
- CosmosDbException
- Base CosmosDbException class for CosmosDB errors.
- ForbiddenException
- InternalException
- InvalidTokenException
- NotFoundException
- NotModifiedException
- PreconditionFailureException
- UnknownDocumentTypeException