Azure Cosmos task list

[smitpatel]

Note: This issue is to track smaller task items for EFCore.Cosmos.Sql provider. Use #8443 for discussions/questions.

---

2.2 Preview 1

• Basic model building
• Discriminator value by default
• Enough metadata support for DDL (database can be created, deleted)
• Query root converted to select expression
• Translate WHERE
• Query execution
• SaveChanges
• Need to figure out how to build our package using this infrastructure
• Navigation rewrite handling of owned types needs to be different (no new query roots) Avoid creating new query roots in navigation rewrite for owned types #13000

2.2 Preview 2

• Binding to JSON objects vs. value buffer (necessary for client-evaluating expressions)

2.2 Preview 3

• Don't map PK to the id property by default, instead map it to a shadow AK and generate a GUID
• Implement async query execution
• Figure out sync pipeline for DDL/DML (underlying API is async) Cosmos.SQL: Implement Sync pipeline for DDL/DML #13160
• ExecutionStrategy support
• Switch to REST API
• Preserve unmapped values (in the JSON) for updates
• Materialize nested owned entity references and collections
• Seeding (requires specifying 'id')
• ToCollection API to map entities to collections explicitly

3.0 Preview 2

• Switch from REST API to the new SDK, use custom user-agent
• Set partition key to null by default
• Remove ToContainer for owned types
• Add ToProperty to configure the store property name. Empty value deactivates persistence.
• Create 'id' value from PK values if not set (Cosmos DB: Issues with surrogate PK design in preview 3 #13633)
  • Add the discriminator of the root type of it's not part of the key
  • Escape the separator in the values
  • Ensure that we don't generate temporary values for the primary key

3.0 Preview 3

• Handle value converters
• Add type mapping
• Fluent API to configure the store property name for embedded entities

3.0 Preview 4

• Ability to select the region to use (CosmosDb provider doesn't support a configuration option for a current region #15007)

3.0 Preview 7

• Use the same CosmosClient instance per context configuration and expose it through Database
• Fluent API to configure discriminator and use it in the convention (allow to remove discriminators for types not sharing a collection)
• IsCosmos extension method
• Partition key configuration API
• Use a JSON wrapper instead of value buffers
• Improve Coalesce translation (Cosmos: Coalesce works on undefined values rather than nulls #16152)

3.0 Preview 8

• Preserve unmapped properties for owned collections (Cosmos: Preserve unmapped properties for owned collections #13578)
• Handle projected owned entities (Cosmos: Track owned entities when included with the owner #13579)
• Handle projected owned collections (Cosmos: Track owned entities when included with the owner #13579)
• Don't persist integer key values for the nested entities
• Review API, including Internal namespace
• Add doc comments
• Add NotNull annotations

3.0 Preview 9

• Add proper exception messages

Potential post-3.0 work

• Add samples and documentation (#12892, Add documentation and samples for the Azure Cosmos provider EntityFramework.Docs#1660)
• Perf tests (Cosmos: Add perf tests #14546)
• Cache the generated SQL query and evaluate parameter values lazily (Cosmos: Cache the generated SQL query and evaluate parameter values lazily #17297)
• Diagnostic events including statistics (query cost, activity id) (Cosmos: Diagnostic events including statistics (query cost, activity id) #17298)
• Concurrency only works with ETags, we need to constrain the API that already exists in core level (Cosmos: ETag concurrency control #17299)
• Support Column property attribute (Cosmos: Add support for Table and Column data annotations #17300)
• API to configure document collection facets (for RU, size, etc.) (Cosmos: API to configure throughput #17301)
• API to set default collection facets on model (Cosmos: API to configure throughput #17301)
• Don't use a discriminator for embedded entities without inheritance (Cosmos: Don't use a discriminator for embedded entities without inheritance #17302)
• Support hash and range indexes https://docs.microsoft.com/en-us/azure/cosmos-db/index-types (Cosmos: Support composite, hash and range indexes #17303)
• Support unique keys https://docs.microsoft.com/en-us/azure/cosmos-db/unique-keys (Cosmos: Support unique keys #17305)
• Basic scalar collection mapping (Cosmos: Add basic support for collections and dictionaries of primitive types #14762)
• Deal with missing property values ('Derived method 'HasTables' - cannot reduce access (Nightly 3.0.0-preview7.19313.16) #16105)
• Provide access to unmapped properties (JSON or property bag) / JSON from root entry / JSON entity properties. Allow to plugin a custom JSON serializer by replacing a service. (Cosmos: Allow to use a custom JSON serializer #17306)
• Configure TTL per document (Cosmos: Configure TTL per entity/entity type/container #17307)
• Update/insert batching (Cosmos: CUD batching #17308)
• Support incremental updates (Cosmos: Allow partial updates #13559). Allow to specify custom sprocs
• Multiple query data consistency using consistency level and session token headers (Cosmos: Allow to specify consistency level for CUD operations #17309)
• Optimize Find by using 'id' (Cosmos: Optimize Find by querying by 'id' #17310)
• FromSql support (Cosmos: FromSql support #17311)
• Built-in functions and operators mappings (Cosmos: Add translators for member/methods which map to built-in functions #16143, Cosmos: Bitwise operators on booleans return incorrect results #13168)
• User defined functions (Cosmos: Support UDFs #15338)
• Handle complex order by expressions (Cosmos: Complex order by support #16150)
• Translate aggregate operators (Cosmos: Support aggregate operators #16146)
• Translate projection over embedded collection (Cosmos: Translate composition over embedded non-primitive collection #16926)
• Translate SelectMany (Cosmos: Translate SelectMany #17312)
• Translate GroupBy (Cosmos: Translate GroupBy #17313)
• Translate LeftJoin (Cosmos: Translate LeftJoin #17314)
• Translate Skip and Take (Cosmos: Translate Skip and Take #15734)
• Translate is (Cosmos: Translate is operator #16391)
• Non-owned Include support (Cosmos: Add Include support #16920)
• Optimize query SQL (Cosmos: Optimize query SQL #13159)
• IN operator optimization (CosmosDb: Optimize into "IN" operator #12635)
• Support splitting big entities into several items (2MB limit) (Cosmos: Entity splitting #17315)
• Add keyless type support (Cosmos: Add tests for keyless entities #17316)
• Spatial types (uses GeoJSON which supports point, polygon and linestring cc @bricelam) and functions and spatial indexes (Cosmos: Spatial types, functions and spatial indexes #17317)
• Partition key handling in queries (Cosmos: Improve single-partition queries #17318)
• Helpers for Cosmos DB's change feed (Cosmos: Change feed support #17319)
• Handle queries that require feed options to execute across partitions (Cosmos: Add explicit partition key support for queries #17320)
• CLI options to create/drop database (Cosmos: CLI tools #17321)

[aidapsibr]

Probably don't call my tables Unicorn. 🦄 😄

[divega]

@psibernetic Yes, we are planning to change that after preview. One possible solution is to name it after the derived DbContext type.

[aidapsibr]

Sounds like a great solution, thanks!

[kierenj]

Hi, I see on the announcement of 2.2 Preview 2 (https://devblogs.microsoft.com/dotnet/announcing-entity-framework-core-2-2-preview-2/) :

"No nesting of owned entities in documents: We are planning to use entity ownership to decide when an entity should be serialized as part of the same JSON document as the owner. In fact we are extending the ability to specify ownership to collections in 2.2. However this behavior hasn’t been implemented yet and each entity is stored as its own document."

This GH issue is then linked as a means to check the status of items, but I can't see any items here about nesting owned entities. Is this in place on the previews, or any non-preview version?

[AndriySvyryd]

@kierenj It's implemented since 2.2 Preview 3

• Materialize owned entity references and collections

[AndriySvyryd]

All the feature work planned for 3.0 has been completed.

[mdarefull]

Is there an active task list or feed to subscribe to get notified as new features get added in general?

[AndriySvyryd]

@mdarefull #19549