Browse the documentation

API overview

The main collection and diagnostic members.

INetlyDBCollection<T>

The application-facing typed collection, registered by AddNetlyDBCollection<T>().

MemberPurpose
Add / AddAsyncInsert one document; optional time-to-live. Returns the id.
AddRange / AddBatch (+ Async)Insert many documents; AddRangeAsync also streams from an IAsyncEnumerable.
Find / FindAsyncLoad a document by id.
All / AllAsyncEvery document in the collection.
Query()A fluent query with LINQ or filter-string Where, ordering and paging.
ListAsync / FirstOrDefaultAsync / AnyAsync / CountAsyncQuery with a LINQ predicate or a filter string.
Update / UpdateAsyncReplace a document by id.
UpdateWhereAsyncSet fields on every document matching a predicate.
Delete / DeleteAsync / DeleteWhereAsyncRemove by id or by predicate.
CreateIndexDeclare an index from a property expression.
CreateFullTextIndex / FullTextSearchBM25 keyword index and ranked search.
CreateVectorIndex / CreateExternalVectorIndexFlat or HNSW vector index, on a property or kept externally.
SetVector / SetVectors / VectorSearchStore vectors by document id; k-nearest-neighbour search.

IDocumentCollection<T>

The lower-level collection, resolved from dependency injection or opened through IDocumentStore. In addition to the operations above it offers:

MemberPurpose
WhereAsyncQuery with a filter string, LINQ or a JSON filter; the result carries a query Explanation.
SelectAsync / QueryAsyncSELECT projections, and text UPDATE / DELETE statements.
TryUpdate / TryDeleteOptimistic concurrency: succeed only when the document is at the expected revision.
GetMutationStatusAsyncResolve what happened to a write whose outcome was indeterminate.

Stores

  • IDocumentStore - open document collections by type or name, list collections and their schemas.
  • IFileStore - open and create file collections.
  • INamedNetlyDBCollectionProvider<T> - resolve named collections of one type.

Diagnostic members are listed on Diagnostics.

An unhandled error has occurred. Reload X

Reconnecting

Restoring the connection to the server...

Still trying

Next attempt in seconds

Connection lost

We could not reach the server.