# database-metadata-bind

**Repository Path**: jjfinal/database-metadata-bind

## Basic Information

- **Project Name**: database-metadata-bind
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: develop
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-02-26
- **Last Updated**: 2026-02-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# database-metadata-bind

[![Java CI with Maven](https://github.com/jinahya/database-metadata-bind/actions/workflows/maven.yml/badge.svg)](https://github.com/jinahya/database-metadata-bind/actions/workflows/maven.yml)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=jinahya_database-metadata-bind&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=jinahya_database-metadata-bind)
[![Maven Central](https://img.shields.io/maven-central/v/com.github.jinahya/database-metadata-bind)](https://search.maven.org/artifact/com.github.jinahya/database-metadata-bind)
[![javadoc](https://javadoc.io/badge2/com.github.jinahya/database-metadata-bind/javadoc.svg)](https://javadoc.io/doc/com.github.jinahya/database-metadata-bind)

A library for binding results of methods defined
in [DatabaseMetaData](http://docs.oracle.com/javase/8/docs/api/java/sql/DatabaseMetaData.html).

## Coordinates

See [Maven Central](https://central.sonatype.com/artifact/io.github.jinahya/database-metadata-bind/overview) for available versions.

```xml
<dependency>
  <groupId>io.github.jinahya</groupId>
  <artifactId>database-metadata-bind</artifactId>
</dependency>
```

## Usages

All 26 methods in `DatabaseMetaData` that return `ResultSet` are bound to type-safe Java classes.

### Basic Usage

```java
try (var connection = dataSource.getConnection()) {
    var context = Context.newInstance(connection.getMetaData());

    // Get all catalogs
    List<Catalog> catalogs = context.getCatalogs();

    // Get all tables (null = don't filter)
    List<Table> tables = context.getTables(null, null, "%", null);

    // Get columns for a specific table
    List<Column> columns = context.getColumns("my_catalog", "my_schema", "my_table", "%");
}
```

### Working with Results

```java
// Tables have typed accessors
for (Table table : tables) {
    String catalog = table.getTableCat();    // may be null
    String schema = table.getTableSchem();   // may be null
    String name = table.getTableName();
    String type = table.getTableType();      // "TABLE", "VIEW", etc.
}

// Get primary keys for a table
List<PrimaryKey> pks = context.getPrimaryKeys(
    table.getTableCat(),
    table.getTableSchem(),
    table.getTableName()
);

// Get foreign keys pointing to this table
List<ExportedKey> exportedKeys = context.getExportedKeys(
    table.getTableCat(),
    table.getTableSchem(),
    table.getTableName()
);
```

### Catalog/Schema Null Handling

JDBC uses `null` to mean "not applicable" in results and "don't filter" in parameters. This aligns naturally:

```java
// Get a table (catalog/schema may be null depending on database)
Table table = tables.get(0);

// Pass values directly — null means "don't filter by this"
List<Column> columns = context.getColumns(
    table.getTableCat(),     // null → don't filter by catalog
    table.getTableSchem(),   // null → don't filter by schema
    table.getTableName(),
    "%"
);
```

## How to contribute?

A lot of classes/methods defined in this module need to be tested with various kinds of real databases.

### Add your JDBC driver as a test-scoped dependency.

```xml
<dependency>
  ...
  <scope>test</scope>
</dependency>
```

### Run the `ExternalIT` class with `url`, `user`, and `password` parameter.

```commandline
$ mvn \
  -Pfailsafe \
  -Dit.test=ExternalIT \
  -Durl='<your-jdbc-url>' \
  -Duser='<your-own-user>' \
  -Dpassword='<your-own-password>' \
  clean test-compile failsafe:integration-test
```

----

## Links

### Docker
* [Running Oracle XE with TestContainers on Apple Silicon](https://blog.jdriven.com/2022/07/running-oracle-xe-with-testcontainers-on-apple-silicon/)

### MariaDB
* [getTables should be ordered as expected](https://jira.mariadb.org/browse/CONJ-1156)
* [DatabaseMetaData#getFunctions's result not property ordered](https://jira.mariadb.org/browse/CONJ-1158)
* [DatabaseMetaData#getClientInfoProperties not ordered correctly](https://jira.mariadb.org/browse/CONJ-1159)

### MySQL
* [DatabaseMetaData#getTables produces duplicates](https://bugs.mysql.com/bug.php?id=113970&thanks=4)

### PostgreSQL
* [DatabaseMetaData#getFunctionColumns's result has duplicate](https://github.com/pgjdbc/pgjdbc/issues/3127)

### SQL Server
* [DatabaseMetaData#getProcedures not ordered as specified](https://github.com/microsoft/mssql-jdbc/issues/2321)