index

Functions

Function	Description
getDatetimeJsonLogicOperations	Custom operations for use with JsonLogic objects generated by datetimeRuleProcessorJsonLogic.
getDatetimeRuleProcessorCEL	Generates a rule processor with date/time features for use by formatQuery with the "cel" format.
getDatetimeRuleProcessorCypher	Generates a rule processor with date/time features for use by formatQuery with the "cypher" or "gql" format.
getDatetimeRuleProcessorDrizzle	Generates a rule processor with date/time features for use by formatQuery with the "drizzle" format. Relative values are materialized and all date/time values are converted to Date objects (Drizzle column operators compare against native Date values).
getDatetimeRuleProcessorElasticSearch	Generates a rule processor with date/time features for use by formatQuery with the "elasticsearch" format. Relative values are materialized to concrete ISO 8601 strings (ElasticSearch has no symbolic relative form); absolute values pass through.
getDatetimeRuleProcessorGremlin	Generates a rule processor with date/time features for use by formatQuery with the "gremlin" format. Relative values are materialized to concrete ISO 8601 strings (Gremlin has no symbolic relative form); absolute values pass through.
getDatetimeRuleProcessorJSONata	Generates a rule processor with date/time features for use by formatQuery with the "jsonata" format.
getDatetimeRuleProcessorLDAP	Generates a rule processor with date/time features for use by formatQuery with the "ldap" format. Relative values are materialized to concrete ISO 8601 strings (LDAP has no symbolic relative form); absolute values pass through.
getDatetimeRuleProcessorMongoDB	Generates a rule processor with date/time features for use by formatQuery with the (deprecated) "mongodb" format. Delegates to the "mongodb_query" date/time processor and serializes the result; Date values serialize to ISO 8601 strings.
getDatetimeRuleProcessorMongoDBQuery	Generates a rule processor with date/time features for use by formatQuery with the "mongodb_query" format.
getDatetimeRuleProcessorNL	Generates a rule processor with date/time features for use by formatQuery with the "natural_language" format.
getDatetimeRuleProcessorParameterized	Generates a rule processor with date/time features for use by formatQuery with the "parameterized" and "parameterized_named" formats. Relative values are materialized to concrete ISO 8601 strings (these formats have no symbolic relative form); absolute values pass through.
getDatetimeRuleProcessorPrisma	Generates a rule processor with date/time features for use by formatQuery with the "prisma" format. Relative values are materialized and all date/time values are converted to Date objects (Prisma's where clauses use native Date values for date columns).
getDatetimeRuleProcessorSequelize	Generates a rule processor with date/time features for use by formatQuery with the "sequelize" format. Relative values are materialized and all date/time values are converted to Date objects (Sequelize where clauses use native Date values for date columns).
getDatetimeRuleProcessorSPARQL	Generates a rule processor with date/time features for use by formatQuery with the "sparql" format.
getDatetimeRuleProcessorSpEL	Generates a rule processor with date/time features for use by formatQuery with the "spel" format. Relative values are materialized to concrete ISO 8601 strings (SpEL has no symbolic relative form); absolute values pass through.
getDatetimeRuleProcessorSQL	Generates a rule processor with date/time features for use by formatQuery with the "sql" format.
getDatetimeRuleProcessorTanStackDB	Generates a rule processor with date/time features for use by formatQuery with the "tanstack_db" format. Relative values are materialized and all date/time values are converted to Date objects (TanStack DB collection filters compare against native Date values).
getDatetimeValueProcessorANSI	Generates a value processor with date/time features for use by formatQuery with the "sql" format and "ansi" preset.
getDatetimeValueProcessorMSSQL	Generates a value processor with date/time features for use by formatQuery with the "sql" format and "mssql" preset.
getDatetimeValueProcessorMySQL	Generates a value processor with date/time features for use by formatQuery with the "sql" format and "mysql" preset.
getDatetimeValueProcessorOracle	Generates a value processor with date/time features for use by formatQuery with the "sql" format and "oracle" preset.
getDatetimeValueProcessorPostgreSQL	Generates a value processor with date/time features for use by formatQuery with the "sql" format and "postgresql" preset.

Interfaces

Interface	Description
RelativeDateTimeValue	Structured representation of a relative date/time value, e.g. "three months ago" or "the beginning of this year". Stored as the value of a rule (in place of the usual ISO 8601 string) and recognized by the date/time rule processors.
RQBDateTimeLibraryAPI	-
RQBJsonLogicDateAfter	-
RQBJsonLogicDateBefore	-
RQBJsonLogicDateBetween	-
RQBJsonLogicDateIn	-
RQBJsonLogicDateNotBetween	-
RQBJsonLogicDateNotIn	-
RQBJsonLogicDateNotOn	-
RQBJsonLogicDateOn	-
RQBJsonLogicDateOnOrAfter	-
RQBJsonLogicDateOnOrBefore	-
RQBJsonLogicDateRelative	-

Type Aliases

Type Alias	Description
IsDateField	-
IsDateFieldFunction	-
RelativeDateTimeAnchor	Reference point (zero-offset) for a RelativeDateTimeValue. 'now' is the current date/time; the startOf*/endOf* anchors truncate to the start or end of the corresponding calendar period.
RelativeDateTimeTruncationUnit	Unit of measure for truncating a date/time to the start or end of a period (the subset of RelativeDateTimeUnit that represents a calendar period).
RelativeDateTimeUnit	Unit of measure for a relative date/time offset.
RQBDateTimeJsonLogic	JsonLogic rule object with additional operators generated by formatQuery and accepted by parseJsonLogic.
RQBJsonLogicDateTimeOperations	-

Variables

Variable	Description
datetimeRuleProcessorJsonLogic	Date/time rule processor for use by formatQuery with the "jsonlogic" format.
datetimeValueProcessorNL	Generates a value processor with date/time features for use by formatQuery with the "natural_language" format.
defaultDateTimeNLOperatorMap	-

---

caution

API documentation is generated from the latest commit on the main branch. It may be somewhat inconsistent with official releases of React Query Builder.