Query Syntax

at a high level, queries operate on collections rather than individual documents filter, search, and retrieve specific information based on various criteria using boolean operators, equal and unequal operators, comparison operators, and match operators this article includes an overview of operators and path navigations for building advanced queries in your app, along with real world examples for related information, see the platform manual docid\ yxemkh1com3csuumqcnlf docid\ c v5q9jyhmvemvsdipj2u docid 1cexfnswhjeqa r6yyl 8 boolean operators when a field property is a boolean data type, use explicit true false values enclose groups of logical operations with parentheses to ensure ditto interprets your desired logic correctly for example, to find documents with an "isdeleted" boolean property set to "true" query "isdeleted == true" to find documents with an "isdeleted" boolean property set to "false" query "isdeleted == false" equal (==) and inequality (!=) operators to find documents that match a given key value pair, use the equal operator where you specify the key and the number or string value you want to match separated by == for example, to find documents that have a title equal to "harry potter" query "title == 'harry potter'" if, instead of finding documents that match, you want to find documents that do not match a given key value pair, use the inequality operator where you specify the key and the value that you don’t want to match separated by != for example, to find documents that are not of the title "lord of the rings" query "title != 'lord of the rings'" comparison operators (>=)(>)(<=)(<) compare values in documents, set conditions, retrieve specific documents that meet your criteria, and make logical evaluations using the following operators in your query statements ditto supports parsing iso 8601 date strings, so you can use iso 8601 formatted date strings in queries for comparison operations for more information, see docid 1cexfnswhjeqa r6yyl 8 for example to find documents where age field property is less than or equal to the value of 18 query "age <= 18" to find documents where the age field property is less than the value of 18 query "age < 18" to find documents where the age field property is greater than or equal to the value of 18 query "age >= 18" to find documents where the age field property is greater than the value of 18 query "age > 18" compound operators perform complex operations in a single executable by using compound operators a compound operator is a combination of two or more operators in a single executable sql ditto and && or || not ! contains( ) contains( ) logical and predicate statements (&&) similar to sql and statements, use && for a condition that evaluates to true only when all of its conditions are set to true for example, to find documents that have a theme field property equal to "dark" and a name field property equal to "light" query "theme == 'dark' && name == 'light' logical or statements (||) similar to sql or statements, use || for a logical or predicate statement for example, to find documents that are "tom" or "arthur" query "name == 'tom' || name == 'arthur'" logical not statements (!) similar to sql not statements, use ! for logical not predicate statements for example, find documents that are neither "hamilton" nor "morten" query "name != 'tom'" string operations use starts with(property, test) to test if a field property with a string value starts with a test string for example, to find documents with a title field property that begins with "lord" query "starts with(title, 'lord')" use ends with(property, test) to test if a field property with a string value ends with a test string for example, to find documents with a title field property that ends with "rings" query "ends with(title, 'rings')" use regex(property, test) to see if a field property with a string value passes a regular expression for more information, see the official mozilla developer network docs (mdn) > https //developer mozilla org/en us/docs/web/javascript/guide/regular expressions for example, to find documents containing only upper and lowercase letters, numbers, and underscores query "regex(title, '^(\[a za z]|\[0 9]| )+$')" // a title property of "abc129 24a" will pass // a title property of "abc129 24a 3" will not pass null values use null to check for the existence of a value of a given field for example, to find documents with a color field property that has no value query "color == null" array operators when handling collections of data that different peers may make concurrent updates to, first consider using an embedded map structure if necessary, use an array the array type in ditto is a crdt and behaves differently than the primitive array type for more information, see the platform manual > docid\ yxemkh1com3csuumqcnlf avoid using arrays in ditto due to potential merge conflicts when offline peers reconnect to the mesh and attempt to sync their updates, especially when multiple peers make concurrent updates to the same item within the array operator operation contains(array, value) checks for value in the array query "contains(\['blue', 'green'], color)" date and time formats when parsing date and time strings, use the iso 8601 standard format, as follows for more information, see platform manual > docid\ c v5q9jyhmvemvsdipj2u query "created at >= '2022 04 29t00 55 31 859z'" field path navigation if fields consist of alphanumeric characters or include underscores, use any of the following notations to navigate document properties for fields that are alphanumeric or include underscores, use dot notation query "name last == 'turing'" for all other scenarios, use bracket notation query "work\['street line'] == '678 johnson street'"