system property which can be used to set the default allow auto number insert policy. Defaults to false.

(boolean) system property which can be used to indicate that the current vm has a poor nio implementation (specifically for FileChannel.transferFrom)

system property prefix which can be used to set the default Charset used for text data (full property includes the JetFormat version).

system property which can be used to set the default sort order for table columns. Value should be one of Table.ColumnOrder enum values.

system property which can be used to set the default date/Time type. Value should be one of DateTimeType enum values.

default value for the auto-sync value (true). this is slower, but leaves more chance of a useable database in the face of failures.

the default sort order for table columns.

system property which can be used to disable expression evaluation if necessary. Defaults to true.

system property which can be used to set the default enforcement of foreign-key relationships. Defaults to true.

system property which can be used to set the path from which classpath resources are loaded (must end with a "/" if non-empty). Default value is io/github/spannm/jackcess/ if unspecified.

system property which can be used to set the default TimeZone used for date calculations.

System property which can be used to allow writing indexes with unsupported text sort orders. Defaults to false. When enabled, instead of failing, an index with an unsupported text sort order will be written using the general legacy sort order. This allows the database to be created with all the structure necessary by Jackcess, and the index can then be fixed by using "compact and repair" in MS Access.

Redeclares java.io.Closeable.close.

Close the database file (and any linked databases). A Database must be closed after use or changes could be lost and the Database file corrupted. A Database instance should be treated like any other external resource which would be closed in a finally block (e.g. an OutputStream or jdbc Connection).

Annotations

@Override

Exceptions

IOException:

Doc from java.io.Closeable.close.

if an I/O error occurs

Create a new table in this database

Parameters

name:String

Name of the table to create in this database

linkedDbName:String

path to the linked database

linkedTableName:String

name of the table in the linked database

Redeclares java.io.Flushable.flush.

Flushes any current changes to the database file (and any linked databases) to disk.

Annotations

@Override

Exceptions

IOException:

Doc from java.io.Flushable.flush.

If an I/O error occurs

Gets currently configured Charset (always non-null).

Gets currently configured Table.ColumnOrder (always non-null).

Gets currently configured ColumnValidatorFactory (always non-null).

Returns the current database password, or null if none set.

Returns:String

the current database password, or null if none set.

Returns the core properties for the database.

Returns:PropertyMap

the core properties for the database

Gets the currently configured DateTimeType.

Gets the currently configured ErrorHandler (always non-null). This will be used to handle all errors unless overridden at the Table or Cursor level.

Returns the EvalConfig for configuring expression evaluation.

Returns the File underlying this Database

Returns the FileFormat of this database (which may involve inspecting the database itself).

Exceptions

IllegalStateException:

if the file format cannot be determined

Returns an unmodifiable view of the currently loaded linked databases, mapped from the linked database file name to the linked database. This information may be useful for implementing a LinkResolver.

Gets the currently configured LinkResolver (always non-null). This will be used to handle all linked database loading.

Returns the File underlying this Database

Finds all the queries in the database.

Finds all the relationships in the database between the given tables.

Finds all the relationships in the database for the given table.

Finds all the relationships in the database in non-system tables.

Warning, this may load all the Tables (metadata, not data) in the database which could cause memory issues.

Returns the summary properties for the database.

Returns:PropertyMap

the summary properties for the database

Finds all the relationships in the database, including system tables.

Warning, this may load all the Tables (metadata, not data) in the database which could cause memory issues.

Returns a reference to any available table in this access database, including system tables.

Warning, this method is not designed for common use, only for the occassional time when access to a system table is necessary. Messing with system tables can strip the paint off your house and give your whole family a permanent, orange afro. You have been warned.

Parameters

tableName:String

Table name, may be a system table

Returns:Table

The table, or null if it doesn't exist

Returns the names of all of the system tables (String). Note, in order to read these tables, you must use getSystemTable. Extreme care should be taken if modifying these tables directly!.

Returns:Set<String>

The names of all of the system tables (String). Note, in order to read these tables, you must use getSystemTable. Extreme care should be taken if modifying these tables directly!.

Returns the Table, or null if it doesn't exist (or is a system table).

Parameters

name:String

User table name (case-insensitive)

Returns:Table

The Table, or null if it doesn't exist (or is a system table)

Returns the meta data for the table, or null if it doesn't exist.

Parameters

name:String

Table name (case-insensitive), may be any table type (i.e. includes system or linked tables).

Returns:TableMetaData

The meta data for the table, or null if it doesn't exist

Returns the names of all of the user tables.

Returns:Set<String>

The names of all of the user tables

Gets currently configured TimeZone (always non-null and aligned with the ZoneId).

Returns the user-defined properties for the database.

Returns:PropertyMap

the user-defined properties for the database

Gets currently configured ZoneId (always non-null and aligned with the TimeZone).

Gets current allow auto number insert policy. By default, jackcess does not allow auto numbers to be inserted or updated directly (they are always handled internally by the Table). Setting this policy to true allows the caller to optionally set the value explicitly when adding or updating rows (if a value is not provided, it will still be handled internally by the Table). This value can be set database-wide using setAllowAutoNumberInsert and/or on a per-table basis using Table#setAllowAutoNumberInsert (and/or on a jvm-wide using the ALLOW_AUTONUM_INSERT_PROPERTY system property). Note that enabling this feature should be done with care to reduce the chances of screwing up the database.

Gets current foreign-key enforcement policy.

Gets the current expression evaluation policy. Expression evaluation is enabled by default but can be disabled if necessary.

Returns true if this Database links to the given Table, false otherwise.

Gets the current write broken index policy. See WRITE_BROKEN_INDEX_PROPERTY for details.

Redeclares java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Returns:Iterator<Table>

an unmodifiable Iterator of the user Tables in this Database.

Annotations

@Override

Exceptions

UncheckedIOException:

if an IOException is thrown by one of the operations, the actual exception will be contained within

ConcurrentModificationException:

if a table is added to the database while an Iterator is in use.

Convenience method for constructing a new TableIterableBuilder for this cursor. A TableIterableBuilder provides a variety of options for more flexible iteration of Tables.

Returns an Iterable which returns an unmodifiable Iterator of the the TableMetaData for all tables in this Database.

Returns:Iterable<TableMetaData>

an Iterable which returns an unmodifiable Iterator of the the TableMetaData for all tables in this Database.

Exceptions

UncheckedIOException:

if an IOException is thrown by one of the operations, the actual exception will be contained within

ConcurrentModificationException:

if a table is added to the database while an Iterator is in use.

Returns a Stream using the newTableMetaDataIterable.

Returns:Stream<TableMetaData>

a Stream using the newTableMetaDataIterable

Sets the new auto number insert policy for the database (unless overridden at the Table level). If null, resets to the default value.

Sets a new Charset. If null, resets to the default value.

Sets a new Table.ColumnOrder. If null, resets to the default value.

Sets a new ColumnValidatorFactory. If null, resets to the default value. The configured ColumnValidatorFactory will be used to create ColumnValidator instances on any user tables loaded from this point onward (this will not be used for system tables).

Sets the DateTimeType. If null, resets to the default value.

Sets a new foreign-key enforcement policy. If null, resets to the default value.

Sets a new ErrorHandler. If null, resets to the ErrorHandler#DEFAULT.

Sets the current expression evaluation policy. Expression evaluation is enabled by default but can be disabled if necessary. If null, resets to the default value.

Sets a new LinkResolver. If null, resets to the LinkResolver#DEFAULT, which disables automatic linked database resolution. Use LinkResolver#UNRESTRICTED only for trusted linked database paths.

Sets a new TimeZone. If null, resets to the default value. Note that setting the TimeZone will alter the ZoneId as well.

Sets the current write broken index policy. If null, resets to the default value.

Sets a new ZoneId. If null, resets to the default value. Note that setting the ZoneId will alter the TimeZone as well.

Returns a Stream using the default Iterator.

Returns:Stream<Table>

a Stream using the default Iterator.