Home
HCL Domino Designer Basic User Guide and Reference
This guide provides information on using HCL Domino Designer and programming language reference information.
Domino® Query Language
Domino® Query Language (DQL) is a facility running on a Domino server that provides a terse, shorthand syntax for finding documents. It supports a wide variety and complexity of search terms. It leverages existing design elements, avoiding the need to write detailed code to access them. DQL consolidates all methods in Domino for searching document contents.
Design catalog
For high speed access to internal information about views and view columns, DQL processing uses a design catalog that contains design data extracted from view notes. Use updall command to add a design catalog to individual databases and to keep the design catalog up to date.

HCL Domino Designer Basic User Guide and Reference
This guide provides information on using HCL Domino Designer and programming language reference information.
- What's new in HCL Domino Designer 12?
  The following features are new for developers in HCL Domino® Designer 12.
- Accessibility and keyboard shortcuts
  Accessibility features assist users who have a disability, such as restricted mobility or limited vision, to use information technology content successfully.
- Application Design
  Welcome to the Application Design section of Domino® Designer Help.
- Application Management
  Welcome to the Application Management section of Domino® Designer Help.
- Domino® Query Language
  Domino® Query Language (DQL) is a facility running on a Domino server that provides a terse, shorthand syntax for finding documents. It supports a wide variety and complexity of search terms. It leverages existing design elements, avoiding the need to write detailed code to access them. DQL consolidates all methods in Domino for searching document contents.
  - Getting started
    Before you use Domino® Query Language (DQL), create the equivalent of an internal design catalog in each database against which query requests are processed. The design catalog is maintained in hidden documents within a database and provides a high-speed mechanism to find critical design data at runtime.
  - DQL syntax
    DQL can be executed in the LotusScript® or Java™ Query method on the (Notes®) Database object or the domino-db node.js API.
  - Examples of simple queries
    Here are some examples of simple queries.
  - Value data types
    Domino® features a typeless data model where any type of data can be stored in any field. In a DQL query, the type of data searched for is defined by the type of data specified in the query term:
  - Booleans
    Here are some examples that couple simple queries with Boolean processing.
  - Precedence
    DQL has a natural precedence (order of processing) where ANDed terms are processed before ORed terms.
  - in all
    The all keyword modifies the inclusive in operator to exclude all but a specified list of values.
  - contains
    New in Domino 11: In addition to using NSF scanning and view indexes, DQL provides the contains operator to process queries against full text indexes. A database must have a full text index to be processed in this way.
  - Formula Language
    Beginning in HCL Domino® 12, Formula Language can be used in Domino Query Language (DQL) search terms.
  - Text string values
    Text string evaluation is case insensitive and accent insensitive. Use a single quote (') to forces DQL processing to interpret arguments as text rather than date/times or numerals.
  - Date and time values
    DQL supports the RFC3339 standard format for date-time strings.
  - Substitution variables
    Since it is useful to run DQL queries that vary only by the values in any given term, it is tempting to build them using string construction. But building DQL queries using string construction can be a security weakness. DQL supports substitution variables in its syntax so a query can remain unchanged but differing values can be supplied.
  - View column requirements
    DQL processing requires primary collated columns for view access that must meet specific requirements.
  - Scanning limits
    Though the DQL processing engine takes measures to avoid dominating system resources, it is still possible to write and execute a runaway query. To prevent that, three limit settings are provided.
  - Performance and resource use
    DQL processing consumes memory, disk and CPU resources. To preserve those resources and to speed up query processing, optimize your queries as much as possible.
  - Domino statistics for query analysis
    If DQL is deployed on a Domino server, the show stat query command can be used to report statistics about DQL.
  - Design catalog
    For high speed access to internal information about views and view columns, DQL processing uses a design catalog that contains design data extracted from view notes. Use updall command to add a design catalog to individual databases and to keep the design catalog up to date.
  - DomQuery utility
    The DomQuery command line utility is shipped with the Domino® server and is used to compose and tune queries. Running it with the explain(-e) flag is instrumental in understanding and optimizing DQL syntax and how queries are processed.
  - explain
    The best way to understand how DQL syntax will be processed is by using the explain facility. Explain is available as a method in the DominoQuery class (Java) and NotesDominoQuery class (LotusScript) and with the DomQuery utility using the explain (-e) flag.
- Composite Applications - Design and Management
  Composite applications are a key element in a service-oriented architecture (SOA) and contextual collaboration strategy. The ability to create and edit composite applications lets you easily integrate different types of components and technologies.
- DB2® Access views
  Domino® Designer includes two types of design elements to assist you in managing data contained in DB2® enabled Notes® databases:
- Programming Overview and User Interface
  This section contains general guidelines and examples that show where to use Java, LotusScript, and the formula language.
- Formula Language
  This section documents the formula language.
- LotusScript® Language
  Welcome to the LotusScript® Language section of Domino® Designer Help.
- LotusScript/COM/OLE Classes
- Java/CORBA Classes
  This section documents the Java/CORBA classes.
- Connectors
  Connectors provide native access to a wide variety of DBMS products, ODBC, the platform File system, Enterprise Resource Planning systems, and Transaction Processing systems.
- Javadoc™ for Domino® Designer related APIs
  As part of providing additional Java™ reference documentation, Domino® Designer ships with a help plugin that contains Javadoc™ for additional Domino Designer related APIs.

Design catalog

For high speed access to internal information about views and view columns, DQL processing uses a design catalog that contains design data extracted from view notes. Use updall command to add a design catalog to individual databases and to keep the design catalog up to date.

Once any database has been catalogued, DQL queries will operate without a design catalog. Only the <'View or folder name'>.<Columnname> syntax will fail. All other syntax will function but there will be no view access and all terms will be satisfied utilizing NSF scanning.

DQL processing is greatly enhanced by adding design catalogs to individual databases. To create a design catalog within a database, use the following command:

load updall <database path> -e

If <database path> is omitted, a design catalog will be added to all databases under the data directory. Doing this is not recommended as it is a rather large superset of what applications need to run DQL.

If you change the design of a view or add a view, run the following command to update the design catalog to make the changes visible to DQL:


load updall <database path> -d

Note: These two updall commands are always run manually.