public interface SqlDataSource
This article compares the
built-in SQL DataSource
to other persistence approaches based on Javabeans.
To use the built-in SQL engine, declare a
DataSource in XML
DataSource.serverType set to
"sql", and place it in the shared dataSources directory
([webroot]/shared/ds by default) in a file called "[dataSourceId].ds.xml".
You can then use the
Admin Console to configure
as well as to automatically create and populate a database table based on your DataSource.
By default, DataSources will use the "default database" from the admin console, however you
DataSource.dbName to the
name of a specific database configuration you have
configured via the Admin Console.
The list of databases known to work with the the built-in SQL logic is as follows:
|HSQLDB 1.7.x, 1.8.x, 2.0.x, 2.2.x, 2.3.x, 2.4.x, 2.5.x
|IBM DB2 8.x, 9.x, 10.x, 11.x
|IBM DB2 for i (formerly known as DB2 for i5/OS) V5R4M0 onwards
|Firebird 2.5.x, 3.x
|Informix 12.10.x, 14.10.x
|MS SQL Server 2000, 2005, 2008, 2008 R2, 2012, 2014, 2016, 2017, 2019
|MySQL 5.0.x, 5.1.x, 5.5.x, 5.6.x, 5.7.x, 8.x
|MariaDB 5.x, 10.x
|Oracle 8.0.5, 8i, 9i, 10g, 11g, 12c, 18c, 19c
|PostgreSQL 7.x, 8.x, 9.x, 10.x, 11.x, 12.x
We also support a generic SQL92 database connection which works for basic CRUD operations with any database product that supports standard SQL92 syntax and data types, plus a couple of widely-implemented features that are not actually part of the standard. Specifically, this means we do not support:
myNumericColumn LIKE '%5%'
You will also need a JDBC driver for your specific database. Licensing restrictions prevent us including any JDBC driver other than the one for HSQLDB. However, you can download these drivers for free from the vendors' websites. If your specific database server or version is not listed above, please go to the Smart GWT forums for assistance.
You can connect to an existing database table by providing a
attribute value. Field-level details can be provided explicitly, if you choose, or these
can be automatically inferred from your schema via
With autoDeriveSchema, you get full SQL connectivity / generation from a one-line .ds.xml
You can of course customize these automatically derived field definitions without
having to reiterate the properties discovered by auto-derivation. For example, the
following field definition overrides an automatically
while preserving metadata obtained from the table, such as type & length:
<field name="information" title="Interesting Facts" />
Once you have your SQL DataSource connected to a table, in a default SDK installation,
DSRequests for your DataSource will be sent to the default
actionURL, and hence handled
automatically, without you having
to write any Java code, by the
registered in web.xml.
IDACall is a very simple servlet that just calls the server-side method
dsRequest.execute() for all inbound requests. For more details on how DataSource requests
are processed by Smart GWT Server, and how you can alter and add to this processing, see
this description of