Home
HCL Domino Designer Basic User Guide and Reference
This guide provides information on using HCL Domino Designer and programming language reference information.
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.
Accessing external databases through LS:DO
Developers are advised not to use LS:DO. Developers should use the Connector LSX for (LCLSX) when accessing external data sources.
ODBCQuery (LotusScript)
Represents the ODBC data access features for defining an SQL statement.
SQL (ODBCQuery - LotusScript)
Read-write. Any SQL statement.

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.
- 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.
  - Connectors and Connectivity Guide
  - LSX for Connectors
    LotusScript® Extensions for Connectors (LC LSX) enhances the power of Notes® by extending its scripting to data outside of Notes through the use of Connectors. The programming model is independent of the individual connector. This eliminates the need to learn each individual system, while at the same time allowing experienced users to access the individual features of a specific system.
  - Accessing external databases through LS:DO
    Developers are advised not to use LS:DO. Developers should use the Connector LSX for (LCLSX) when accessing external data sources.
    - Setting up LS:DO
      Setting up LS:DO requires several steps, in which you install any needed software, register your data sources, and then create your script. Review the following sections as you set up LS:DO for your application:
    - Using LS:DO
      Once you have set up LS:DO and your script, you are ready to access your external databases. With LS:DO, you can:
    - Tips and techniques
      This section presents specialized topics concerned with enhancing your LS:DO application:
    - ODBCConnection (LotusScript)
      Represents the ODBC Data Access features for connecting to a data source.
    - ODBCQuery (LotusScript)
      Represents the ODBC data access features for defining an SQL statement.
      - Examples: ODBCQuery class
        The following agent creates a query that retrieves all the rows in the STUDENTS table of the ATDB data source.
      - Connection (ODBCQuery - LotusScript)
        Write-only. Relates a connection object with a query.
      - QueryExecuteTimeOut (ODBCQuery - LotusScript)
        Read-write. Specifies a time-out value in seconds for query execution.
      - SQL (ODBCQuery - LotusScript)
        Read-write. Any SQL statement.
        Examples: SQL property
        The following example of a view script sets a default query in the Postopen script, then allows the user to specify alternate queries in the Click event of an action. A second action displays the current query. A third action executes the query and displays fields from the result set.
      - UseRowID (ODBCQuery - LotusScript)
        Specifies whether data in the back-end database is accessed by row ID.
      - GetError (ODBCQuery - LotusScript)
        Returns the latest error code for an ODBC object.
      - GetErrorMessage (ODBCQuery - LotusScript)
        Returns the short error message text associated with an error code.
      - GetExtendedErrorMessage (ODBCQuery - LotusScript)
        Returns the long, descriptive error message text associated with an error code.
    - ODBCResultSet (LotusScript)
      Represents the ODBC data access features for performing operations on a result set.
- 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.

SQL (ODBCQuery - LotusScript)

Read-write. Any SQL statement.

Defined in

Data type

String

Syntax

To get: statement$ = odbcQuery . SQL

To set: odbcQuery . SQL = statement$

Usage

When an SQL statement is stored, it is analyzed for parameters, table names, and other items, but full parsing can only be performed by the data source when the statement is executed. There is no practical limit to the length of the SQL statement written, nor is the SQL statement limited to a query (SELECT statement). The SQL statement is not executed until an ODBCResultSet object is created and Execute is performed.

When using the SQL property, be aware that Notes could stop under the following circumstances:

The SQL statement contains the word FROM and it doesn't specify a table name.
While the SQL statement is being checked, memory becomes unavailable.

Statement execution depends on a user's access rights. A user may not be authorized to alter certain fields or tables, perform certain operations, or access certain tables or columns.

Events

BeforeSetSQL

AfterSetSQL