RedBase Documentation

Welcome to the RedBase documentation portal. Browse the API reference, explore code examples, and learn how to build with REDB.

Quick Start Examples

API Reference

Browse the REDB API documentation. Select a namespace or type from the tree on the left, or click on items below.

Search results for: Key Clear search
C Agg redb.Core.Query.Aggregation
M Average<TKey, TProps, TValue>(IRedbGrouping<TKey, TProps>, Expression<Func<TProps, TValue>>) Average in a group: Agg.Average(g, x => x.Age)
M Count<TKey, TProps>(IRedbGrouping<TKey, TProps>) Count in a group: Agg.Count(g)
M Max<TKey, TProps, TValue>(IRedbGrouping<TKey, TProps>, Expression<Func<TProps, TValue>>) Maximum in a group: Agg.Max(g, x => x.Price)
M Min<TKey, TProps, TValue>(IRedbGrouping<TKey, TProps>, Expression<Func<TProps, TValue>>) Minimum in a group: Agg.Min(g, x => x.Price)
M Sum<TKey, TProps, TValue>(IRedbGrouping<TKey, TProps>, Expression<Func<TProps, TValue>>) Sum in a group: Agg.Sum(g, x => x.Stock)
C BaseFilterExpressionParser redb.Core.Query.Parsing
M VisitDictionaryContainsKey(MethodCallExpression) Dictionary.ContainsKey visitor.
C CreateUserRequest redb.Core.Models.Users
P Key Additional user key (optional)
C E060_DictContainsKey redb.Examples.Examples
C E063_DictTupleKey redb.Examples.Examples
C E130_GroupByMultiKey redb.Examples.Examples
C ExpressionSqlCache redb.Core.Query.Caching
M BuildCacheKey<TProps>(Expression<Func<TProps, bool>>, long) Generates stable cache key from Expression (without constant values).
M BuildCacheKey<TProps>(Expression<Func<TProps, bool>>?, IEnumerable<(string field, bool desc)>?, long) Generates cache key for ordering + filter combination.
C FieldInfo redb.Core.Query.Models
P DictKey For Dictionary fields: the key (e.g., "home" for PhoneBook["home"])
C FieldPathInfo redb.Core.Query.Projection
P DictKey Dictionary key (for AddressBook["home"])
C GroupedWindowedQueryable<TKey, TProps> redb.Core.Query.Grouping
T GroupedWindowedQueryable(IRedbQueryProvider, long, Expression, GroupedWindowSpec<TKey, TProps>, FilterExpression?) Constructor with FilterExpression (Pro version).
T GroupedWindowedQueryable(IRedbQueryProvider, long, Expression, GroupedWindowSpec<TKey, TProps>, string?) Constructor with filterJson (legacy compatibility).
M SelectAsync<TResult>(Expression<Func<IRedbGrouping<TKey, TProps>, TResult>>) Execute query and materialize results with window functions applied to groups.
M ToSqlStringAsync<TResult>(Expression<Func<IRedbGrouping<TKey, TProps>, TResult>>) Get SQL preview for debugging.
C GroupedWindowSpec<TKey, TProps> redb.Core.Query.Grouping
M OrderBy<TField>(Expression<Func<IRedbGrouping<TKey, TProps>, TField>>) Order rows within window ascending.
M OrderByDesc<TField>(Expression<Func<IRedbGrouping<TKey, TProps>, TField>>) Order rows within window descending.
M PartitionBy<TField>(Expression<Func<TKey, TField>>) Partition window by group key field (for ranking within partitions).
I IGroupedWindowedQueryable<TKey, TProps> redb.Core.Query.Grouping
M SelectAsync<TResult>(Expression<Func<IRedbGrouping<TKey, TProps>, TResult>>) Execute query and materialize results with window functions applied to groups.
M ToSqlStringAsync<TResult>(Expression<Func<IRedbGrouping<TKey, TProps>, TResult>>) Get SQL preview for debugging.
I IGroupedWindowSpec<TKey, TProps> redb.Core.Query.Grouping
M OrderBy<TField>(Expression<Func<IRedbGrouping<TKey, TProps>, TField>>) Order rows within window ascending.
M OrderByDesc<TField>(Expression<Func<IRedbGrouping<TKey, TProps>, TField>>) Order rows within window descending.
M PartitionBy<TField>(Expression<Func<TKey, TField>>) Partition window by group key field (for ranking within partitions).
I IKeyGenerator redb.Core.Data
I IOrderedRedbQueryable<TProps> redb.Core.Query
M ThenBy<TKey>(Expression<Func<TProps, TKey>>) Additional ascending sort by Props field.
M ThenByDescending<TKey>(Expression<Func<TProps, TKey>>) Additional descending sort by Props field.
M ThenByDescendingRedb<TKey>(Expression<Func<IRedbObject, TKey>>) Additional descending sort by IRedbObject base fields.
M ThenByRedb<TKey>(Expression<Func<IRedbObject, TKey>>) Additional ascending sort by IRedbObject base fields.
I IOrderingExpressionParser redb.Core.Query.QueryExpressions
M ParseMultipleOrderings<TProps>(IEnumerable<(LambdaExpression KeySelector, SortDirection Direction)>) Parse multiple sorting
M ParseOrdering<TProps, TKey>(Expression<Func<TProps, TKey>>, SortDirection) Parse sorting expression (Props fields)
M ParseRedbOrdering<TKey>(Expression<Func<IRedbObject, TKey>>, SortDirection) 🆕 Parse sorting expression by base IRedbObject fields (id, name, date_create, etc.)
I IRedbContext redb.Core.Data
P Keys Key generator with caching.
I IRedbGroupedQueryable<TKey, TProps> redb.Core.Query.Grouping
M SelectAsync<TResult>(Expression<Func<IRedbGrouping<TKey, TProps>, TResult>>) Executes projection with aggregations for each group.
M ToSqlStringAsync<TResult>(Expression<Func<IRedbGrouping<TKey, TProps>, TResult>>) Returns SQL string that will be executed for this GroupBy query.
M WithWindow(Action<IGroupedWindowSpec<TKey, TProps>>) Apply window functions to grouped results.
I IRedbGrouping<TKey, TProps> redb.Core.Query.Grouping
P Key Group key (value by which grouped).
I IRedbObject redb.Core.Models.Contracts
P Key Object key field
I IRedbOptionsBuilderInfrastructure redb.Core.Extensions
P LicenseKey License key for Pro features (JWT token).
I IRedbProjectedQueryable<TResult> redb.Core.Query
M OrderBy<TKey>(Expression<Func<TResult, TKey>>) Sort projected results.
M OrderByDescending<TKey>(Expression<Func<TResult, TKey>>) Sort projected results descending.
I IRedbQueryable<TProps> redb.Core.Query
M DistinctBy<TKey>(Expression<Func<TProps, TKey>>) DISTINCT ON (field) - one object per unique Props field value.
M DistinctByRedb<TKey>(Expression<Func<IRedbObject, TKey>>) DISTINCT ON (base_field) - one object per unique IRedbObject base field value.
M GroupBy<TKey>(Expression<Func<TProps, TKey>>) Group by field with subsequent aggregation.
M GroupByArray<TItem, TKey>(Expression<Func<TProps, IEnumerable<TItem>>>, Expression<Func<TItem, TKey>>) Group by array elements (Items[].Property).
M GroupByRedb<TKey>(Expression<Func<IRedbObject, TKey>>) Group by IRedbObject base fields (id, scheme_id, parent_id, etc.).
M OrderBy<TKey>(Expression<Func<TProps, TKey>>) Sort ascending by Props field.
M OrderByDescending<TKey>(Expression<Func<TProps, TKey>>) Sort descending by Props field.
M OrderByDescendingRedb<TKey>(Expression<Func<IRedbObject, TKey>>) Sort descending by IRedbObject base fields.
M OrderByRedb<TKey>(Expression<Func<IRedbObject, TKey>>) Sort ascending by IRedbObject base fields (id, name, date_create, etc.).
I IRedbStructure redb.Core.Models.Contracts
P KeyType Key type ID for Dictionary fields. NULL for non-dictionary fields
I IRedbUser redb.Core.Models.Contracts
P Key Additional user key (optional)
I ISqlDialect redb.Core.Query
M Structures_UpdateKeyType() UPDATE structure key type. Params: $1=keyType, $2=structureId
I IWindowSpec<TProps> redb.Core.Query.Window
M OrderBy<TKey>(Expression<Func<TProps, TKey>>) Sort within window by Props field (ascending).
M OrderByDesc<TKey>(Expression<Func<TProps, TKey>>) Sort within window by Props field (descending).
M OrderByDescRedb<TKey>(Expression<Func<IRedbObject, TKey>>) Sort within window by IRedbObject base field (descending).
M OrderByRedb<TKey>(Expression<Func<IRedbObject, TKey>>) Sort within window by IRedbObject base field (ascending).
M PartitionBy<TKey>(Expression<Func<TProps, TKey>>) Partition by Props field.
M PartitionByRedb<TKey>(Expression<Func<IRedbObject, TKey>>) Partition by IRedbObject base field (SchemeId, OwnerId, etc.).
C LicenseInfo redb.Core.Pro.Licensing
P KeyId RSA key identifier for key rotation (e.g., "app-2024-01")
C MsSqlDialect redb.MSSql.Sql
M Structures_UpdateKeyType() UPDATE structure key type. Params: $1=keyType, $2=structureId
C NpgsqlKeyGenerator redb.Postgres.Data
M GenerateKeysAsync(int) Generate batch of keys from PostgreSQL sequence.
T NpgsqlKeyGenerator(NpgsqlDataSource) Create PostgreSQL key generator.
T NpgsqlKeyGenerator(string) Create PostgreSQL key generator from connection string.
C NpgsqlRedbContext redb.Postgres.Data
P Keys Key generator with caching.
C ObjectRecord redb.Export.Models
P Key Optional numeric key.
C OrderingExpressionParser redb.Core.Query
M ParseMultipleOrderings<TProps>(IEnumerable<(LambdaExpression KeySelector, SortDirection Direction)>) Parse multiple orderings.
M ParseOrdering<TProps, TKey>(Expression<Func<TProps, TKey>>, SortDirection) Parse ordering expression for Props fields.
M ParseRedbOrdering<TKey>(Expression<Func<IRedbObject, TKey>>, SortDirection) Parse sorting by base IRedbObject fields (id, name, date_create, etc.)
C PostgreSqlDialect redb.Postgres.Sql
M Structures_UpdateKeyType() UPDATE structure key type. Params: $1=keyType, $2=structureId
C RedbArrayGroupedQueryable<TKey, TItem, TProps> redb.Core.Query.Grouping
T RedbArrayGroupedQueryable(IRedbQueryProvider, long, string?, Expression<Func<TProps, IEnumerable<TItem>>>, Expression<Func<TItem, TKey>>)
M SelectAsync<TResult>(Expression<Func<IRedbGrouping<TKey, TItem>, TResult>>) Executes projection with aggregations for each group.
M ToSqlStringAsync<TResult>(Expression<Func<IRedbGrouping<TKey, TItem>, TResult>>) Returns SQL string for array GroupBy query.
M WithWindow(Action<IGroupedWindowSpec<TKey, TItem>>) WithWindow not supported for array grouping.
C RedbContextBase redb.Core.Data
P Keys Key generator.
C RedbGroupedQueryable<TKey, TProps> redb.Core.Query.Grouping
M SelectAsync<TResult>(Expression<Func<IRedbGrouping<TKey, TProps>, TResult>>) Executes projection with aggregations for each group.
M ToSqlStringAsync<TResult>(Expression<Func<IRedbGrouping<TKey, TProps>, TResult>>) Returns SQL string that will be executed for this GroupBy query.
M WithWindow(Action<IGroupedWindowSpec<TKey, TProps>>) Apply window functions to grouped results.
C RedbKeyGeneratorBase redb.Core.Data
M GenerateKeysAsync(int) Generate batch of keys from database sequence.
C RedbKeySerializer redb.Core.Utils
M CanBeKey(Type) Check if C# type is valid as Dictionary key
M Deserialize<TKey>(string) Deserialize _array_index text value to key
M GetKeyTypeId(Type) Get RedbTypeIds constant for key type
M IsComplexKey(Type) Check if key type is a complex type requiring JSON serialization
M Serialize<TKey>(TKey) Serialize key to _array_index text value
C RedbObject redb.Core.Models.Entities
P key
P Key Object key field
C RedbObjectRow redb.Core.Models.Entities
P Key External key for integration.
C RedbProjectedQueryable<TProps, TResult> redb.Core.Query
M OrderBy<TKey>(Expression<Func<TResult, TKey>>) Sort projected results.
M OrderByDescending<TKey>(Expression<Func<TResult, TKey>>) Sort projected results descending.
C RedbProjectedQueryableTaskExtensions redb.Core.Query
M OrderBy<TResult, TKey>(Task<IRedbProjectedQueryable<TResult>>, Expression<Func<TResult, TKey>>)
M OrderByDescending<TResult, TKey>(Task<IRedbProjectedQueryable<TResult>>, Expression<Func<TResult, TKey>>)
C RedbQueryable<TProps> redb.Core.Query
M DistinctBy<TKey>(Expression<Func<TProps, TKey>>) DISTINCT ON (field) - one object per unique Props field value.
M DistinctByRedb<TKey>(Expression<Func<IRedbObject, TKey>>) DISTINCT ON (base_field) - one object per unique IRedbObject base field value.
M GroupBy<TKey>(Expression<Func<TProps, TKey>>) Grouping with aggregations.
M GroupByArray<TItem, TKey>(Expression<Func<TProps, IEnumerable<TItem>>>, Expression<Func<TItem, TKey>>) Grouping by array elements
M GroupByRedb<TKey>(Expression<Func<IRedbObject, TKey>>) Grouping by base IRedbObject fields (id, scheme_id, parent_id, etc.)
M OrderBy<TKey>(Expression<Func<TProps, TKey>>) Sort ascending by Props field.
M OrderByDescending<TKey>(Expression<Func<TProps, TKey>>) Sort descending by Props field.
M OrderByDescendingRedb<TKey>(Expression<Func<IRedbObject, TKey>>) Sort descending by IRedbObject base fields.
M OrderByRedb<TKey>(Expression<Func<IRedbObject, TKey>>) Sort ascending by IRedbObject base fields (id, name, date_create, etc.).
M ThenBy<TKey>(Expression<Func<TProps, TKey>>) Additional ascending sort by Props field.
M ThenByDescending<TKey>(Expression<Func<TProps, TKey>>) Additional descending sort by Props field.
M ThenByDescendingRedb<TKey>(Expression<Func<IRedbObject, TKey>>) Additional descending sort by IRedbObject base fields.
M ThenByRedb<TKey>(Expression<Func<IRedbObject, TKey>>) Additional ascending sort by IRedbObject base fields.
C RedbStructure redb.Core.Models.Entities
P KeyType Key type ID for Dictionary fields. NULL for non-dictionary fields.
C RedbTypeMapping redb.Core.Utils
M CanBeKey(long) Check if type can be used as Dictionary key
C RedbUser redb.Core.Models.Entities
P Key Additional user key (optional).
C SchemeMetadataCacheRow redb.Core.Pro.Models
P KeyType
P KeyTypeName
C SqlKeyGenerator redb.MSSql.Data
M GenerateKeysAsync(int) Generate batch of keys from MSSQL sequence.
T SqlKeyGenerator(string) Create MSSQL key generator from connection string.
C SqlRedbContext redb.MSSql.Data
P Keys Key generator with caching.
C StructureRecord redb.Export.Models
P KeyType Key type for dictionary-typed fields.
C TreeGroupedQueryable<TKey, TProps> redb.Core.Query.Grouping
M SelectAsync<TResult>(Expression<Func<IRedbGrouping<TKey, TProps>, TResult>>) Executes projection with aggregations for each group.
M ToSqlStringAsync<TResult>(Expression<Func<IRedbGrouping<TKey, TProps>, TResult>>) Returns SQL string that will be executed for this GroupBy query.
M WithWindow(Action<IGroupedWindowSpec<TKey, TProps>>) Apply window functions to grouped results (tree-aware).
C TreeGroupedWindowedQueryable<TKey, TProps> redb.Core.Query.Grouping
M SelectAsync<TResult>(Expression<Func<IRedbGrouping<TKey, TProps>, TResult>>) Execute query and materialize results with window functions applied to groups.
M ToSqlStringAsync<TResult>(Expression<Func<IRedbGrouping<TKey, TProps>, TResult>>) Get SQL preview for debugging.
T TreeGroupedWindowedQueryable(ITreeQueryProvider, TreeQueryContext<TProps>, Expression, GroupedWindowSpec<TKey, TProps>)
C TreeProjectedQueryable<TProps, TResult> redb.Core.Query
M OrderBy<TKey>(Expression<Func<TResult, TKey>>) Sort projected results.
M OrderByDescending<TKey>(Expression<Func<TResult, TKey>>) Sort projected results descending.
C TreeQueryableBase<TProps> redb.Core.Query.Base
M DistinctBy<TKey>(Expression<Func<TProps, TKey>>) DISTINCT ON (field) - one object per unique Props field value.
M DistinctByRedb<TKey>(Expression<Func<IRedbObject, TKey>>) DISTINCT ON (base_field) - one object per unique IRedbObject base field value.
M GroupBy<TKey>(Expression<Func<TProps, TKey>>) Override GroupBy to respect tree context (rootObjectId, maxDepth, ParentIds).
M GroupByRedb<TKey>(Expression<Func<IRedbObject, TKey>>) Override GroupByRedb to respect tree context.
M OrderBy<TKey>(Expression<Func<TProps, TKey>>) ✅ FIX ISSUE #4: Override OrderBy to preserve Tree context
M OrderByDescending<TKey>(Expression<Func<TProps, TKey>>) ✅ FIX ISSUE #4: Override OrderByDescending for Tree context
M OrderByDescendingRedb<TKey>(Expression<Func<IRedbObject, TKey>>) Sort descending by IRedbObject base fields.
M OrderByRedb<TKey>(Expression<Func<IRedbObject, TKey>>) Sort ascending by IRedbObject base fields (id, name, date_create, etc.).
M ThenBy<TKey>(Expression<Func<TProps, TKey>>) ✅ FIX ISSUE #4: Override ThenBy for Tree context
M ThenByDescending<TKey>(Expression<Func<TProps, TKey>>) ✅ FIX ISSUE #4: Override ThenByDescending for Tree context
M ThenByDescendingRedb<TKey>(Expression<Func<IRedbObject, TKey>>) Additional descending sort by IRedbObject base fields.
M ThenByRedb<TKey>(Expression<Func<IRedbObject, TKey>>) Additional ascending sort by IRedbObject base fields.
C TrustedIssuers redb.Core.Pro.Licensing
M GetPublicKey(string, string) Gets the public key for a specific issuer and key ID.
C UpdateUserRequest redb.Core.Models.Users
P Key New additional key (if null - not changed)
C UserRecord redb.Export.Models
P Key Optional numeric key.
C UserSearchCriteria redb.Core.Models.Users
P KeyValue Filter by user key (exact match)
E UserSortField redb.Core.Models.Users
T Key
C ValueTupleDictionaryConverter<TKey, TValue> redb.Core.Serialization
M Write(Utf8JsonWriter, Dictionary<TKey, TValue>?, JsonSerializerOptions) Writes a specified value as JSON.
C WindowSpec<TProps> redb.Core.Query.Window
M OrderBy<TKey>(Expression<Func<TProps, TKey>>) Sort within window by Props field (ascending).
M OrderByDesc<TKey>(Expression<Func<TProps, TKey>>) Sort within window by Props field (descending).
M OrderByDescRedb<TKey>(Expression<Func<IRedbObject, TKey>>) Sort within window by IRedbObject base field (descending).
M OrderByRedb<TKey>(Expression<Func<IRedbObject, TKey>>) Sort within window by IRedbObject base field (ascending).
M PartitionBy<TKey>(Expression<Func<TProps, TKey>>) Partition by Props field.
M PartitionByRedb<TKey>(Expression<Func<IRedbObject, TKey>>) Partition by IRedbObject base field (SchemeId, OwnerId, etc.).