schemacrawler.server.postgresql.PostgreSQLDatabaseConnector Maven / Gradle / Ivy
/*
========================================================================
SchemaCrawler
http://www.schemacrawler.com
Copyright (c) 2000-2024, Sualeh Fatehi .
All rights reserved.
------------------------------------------------------------------------
SchemaCrawler is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
SchemaCrawler and the accompanying materials are made available under
the terms of the Eclipse Public License v1.0, GNU General Public License
v3 or GNU Lesser General Public License v3.
You may elect to redistribute this code under any of these licenses.
The Eclipse Public License is available at:
http://www.eclipse.org/legal/epl-v10.html
The GNU General Public License v3 and the GNU Lesser General Public
License v3 are available at:
http://www.gnu.org/licenses/
========================================================================
*/
package schemacrawler.server.postgresql;
import schemacrawler.inclusionrule.RegularExpressionExclusionRule;
import schemacrawler.schemacrawler.DatabaseServerType;
import schemacrawler.tools.databaseconnector.DatabaseConnector;
import schemacrawler.tools.executable.commandline.PluginCommand;
import us.fatehi.utility.datasource.DatabaseConnectionSourceBuilder;
public final class PostgreSQLDatabaseConnector extends DatabaseConnector {
public PostgreSQLDatabaseConnector() {
super(
new DatabaseServerType("postgresql", "PostgreSQL"),
url -> url != null && url.startsWith("jdbc:postgresql:"),
(informationSchemaViewsBuilder, connection) ->
informationSchemaViewsBuilder.fromResourceFolder("/postgresql.information_schema"),
(schemaRetrievalOptionsBuilder, connection) ->
schemaRetrievalOptionsBuilder.withEnumDataTypeHelper(
new PostgreSQLEnumDataTypeHelper()),
limitOptionsBuilder ->
limitOptionsBuilder.includeSchemas(
new RegularExpressionExclusionRule("pg_catalog|information_schema")),
() ->
DatabaseConnectionSourceBuilder.builder("jdbc:postgresql://${host}:${port}/${database}")
.withDefaultPort(5432)
.withDefaultUrlx("ApplicationName", "SchemaCrawler")
.withDefaultUrlx("loggerLevel", "DEBUG"));
}
@Override
public PluginCommand getHelpCommand() {
final PluginCommand pluginCommand = super.getHelpCommand();
pluginCommand
.addOption(
"server",
String.class,
"--server=postgresql%n" + "Loads SchemaCrawler plug-in for PostgreSQL")
.addOption(
"host",
String.class,
"Host name%n"
+ "Optional, uses the PGHOSTADDR and PGHOST environmental variables "
+ "if available, or defaults to localhost")
.addOption(
"port",
Integer.class,
"Port number%n"
+ "Optional, uses the PGPORT environmental variable "
+ "if available, or defaults to 5432")
.addOption(
"database",
String.class,
"Database name%n"
+ "Optional, uses the PGDATABASE environmental variable if available");
return pluginCommand;
}
}