Syntax of database connection URLs for applications with embedded databases

For applications with embedded databases, the syntax of the database connection URL is

jdbc:derby:[subsubprotocol:][databaseName][;attributes]*

• jdbc:derby:

  In JDBC terminology, derby is the subprotocol for connecting to a Derby database. The subprotocol is always derby and does not vary.

• subsubprotocol:

  subsubprotocol specifies where Derby looks for a database: in a directory, in memory, in a classpath, or in a jar file. subsubprotocol is one of the following:

  • directory: The default, which need not be specified explicitly. The database is in the file system, and the path is either relative to the system directory or absolute.
  • memory: Databases exist only in main memory and are not written to disk. An in-memory database may be useful when there is no need to persist the database -- for example, in some testing situations. See "Using in-memory databases" in the Derby Developer's Guide for more information.
  • classpath: Databases are treated as read-only databases, relative to the classpath directory. All databaseNames must begin with at least a slash, because you specify them "relative" to the classpath directory or archive. (You do not have to specify classpath as the subsubprotocol; it is implied.) See "Accessing databases from the classpath" in the Derby Developer's Guide for more information.
  • jar: Databases are treated as read-only databases. DatabaseNames might require a leading slash, because you specify them "relative" to the jar file. See "Accessing databases from a jar or zip file" in the Derby Developer's Guide for details.

    jar requires an additional element immediately before the database name:

    (pathToArchive)

    pathToArchive is the path to the jar or zip file that holds the database.

• databaseName

  Specify the databaseName to connect to an existing database or a new one.

  You can specify the database name alone, or with a relative or absolute path. See "Connecting to databases" and its subsections in the Derby Developer's Guide.

• attributes

  Specify zero or more database connection URL attributes as detailed in Attributes of the Derby database connection URL.