the default connection URL that is used by the server.
getCredentials()
publicCredentialsgetCredentials()
Returns the Credentials instance that has been set for this OptionsMetadata.
This overrides both any credentials file and any default credentials in the current runtime
environment.
Returns
Type
Description
com.google.auth.Credentials
getDatabaseName(String database)
publicDatabaseNamegetDatabaseName(Stringdatabase)
Returns the fully qualified database name based on the given database id or name.
Returns the default connection URL that is used by the server. If a default connection URL has
been set, the database parameter in a connection request will be ignored, and the database in
this connection URL will be used instead.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Class OptionsMetadata (0.27.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.27.1 (latest)](/java/docs/reference/pgadapter/latest/com.google.cloud.spanner.pgadapter.metadata.OptionsMetadata)\n- [0.27.0](/java/docs/reference/pgadapter/0.27.0/com.google.cloud.spanner.pgadapter.metadata.OptionsMetadata)\n- [0.26.0](/java/docs/reference/pgadapter/0.26.0/com.google.cloud.spanner.pgadapter.metadata.OptionsMetadata)\n- [0.25.0](/java/docs/reference/pgadapter/0.25.0/com.google.cloud.spanner.pgadapter.metadata.OptionsMetadata)\n- [0.24.0](/java/docs/reference/pgadapter/0.24.0/com.google.cloud.spanner.pgadapter.metadata.OptionsMetadata)\n- [0.23.1](/java/docs/reference/pgadapter/0.23.1/com.google.cloud.spanner.pgadapter.metadata.OptionsMetadata)\n- [0.22.1](/java/docs/reference/pgadapter/0.22.1/com.google.cloud.spanner.pgadapter.metadata.OptionsMetadata)\n- [0.21.0](/java/docs/reference/pgadapter/0.21.0/com.google.cloud.spanner.pgadapter.metadata.OptionsMetadata)\n- [0.20.0](/java/docs/reference/pgadapter/0.20.0/com.google.cloud.spanner.pgadapter.metadata.OptionsMetadata)\n- [0.19.1](/java/docs/reference/pgadapter/0.19.1/com.google.cloud.spanner.pgadapter.metadata.OptionsMetadata)\n- [0.18.4](/java/docs/reference/pgadapter/0.18.4/com.google.cloud.spanner.pgadapter.metadata.OptionsMetadata)\n- [0.17.0](/java/docs/reference/pgadapter/0.17.0/com.google.cloud.spanner.pgadapter.metadata.OptionsMetadata)\n- [0.16.0](/java/docs/reference/pgadapter/0.16.0/com.google.cloud.spanner.pgadapter.metadata.OptionsMetadata)\n- [0.15.0](/java/docs/reference/pgadapter/0.15.0/com.google.cloud.spanner.pgadapter.metadata.OptionsMetadata)\n- [0.14.1](/java/docs/reference/pgadapter/0.14.1/com.google.cloud.spanner.pgadapter.metadata.OptionsMetadata)\n- [0.9.0](/java/docs/reference/pgadapter/0.9.0/com.google.cloud.spanner.pgadapter.metadata.OptionsMetadata)\n- [0.8.0](/java/docs/reference/pgadapter/0.8.0/com.google.cloud.spanner.pgadapter.metadata.OptionsMetadata)\n- [0.7.0](/java/docs/reference/pgadapter/0.7.0/com.google.cloud.spanner.pgadapter.metadata.OptionsMetadata)\n- [0.6.1](/java/docs/reference/pgadapter/0.6.1/com.google.cloud.spanner.pgadapter.metadata.OptionsMetadata)\n- [0.5.1](/java/docs/reference/pgadapter/0.5.1/com.google.cloud.spanner.pgadapter.metadata.OptionsMetadata) \n\n public class OptionsMetadata\n\nMetadata extractor for CLI. \n\nInheritance\n-----------\n\n[java.lang.Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \\\u003e OptionsMetadata \n\nInherited Members\n-----------------\n\n[Object.clone()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--) \n[Object.equals(Object)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-) \n[Object.finalize()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--) \n[Object.getClass()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--) \n[Object.hashCode()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--) \n[Object.notify()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--) \n[Object.notifyAll()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--) \n[Object.toString()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--) \n[Object.wait()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--) \n[Object.wait(long)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-) \n[Object.wait(long,int)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-)\n\nStatic Fields\n-------------\n\n### DEFAULT_SERVER_VERSION\n\n public static final String DEFAULT_SERVER_VERSION\n\nStatic Methods\n--------------\n\n### isJava8()\n\n public static boolean isJava8()\n\nReturns true if the current JVM is Java 8.\n\n### newBuilder()\n\n public static OptionsMetadata.Builder newBuilder()\n\nCreates a Builder for an [OptionsMetadata](/java/docs/reference/pgadapter/latest/com.google.cloud.spanner.pgadapter.metadata.OptionsMetadata) instance.\n\n### toServerVersionNum(String version)\n\n public static String toServerVersionNum(String version)\n\nConstructors\n------------\n\n### OptionsMetadata(String defaultConnectionUrl, int proxyPort, OptionsMetadata.TextFormat textFormat, boolean forceBinary, boolean authenticate, boolean requiresMatcher, boolean replaceJdbcMetadataQueries, JSONObject commandMetadata) (deprecated)\n\n public OptionsMetadata(String defaultConnectionUrl, int proxyPort, OptionsMetadata.TextFormat textFormat, boolean forceBinary, boolean authenticate, boolean requiresMatcher, boolean replaceJdbcMetadataQueries, JSONObject commandMetadata)\n\n**Deprecated.** *Use [#newBuilder()](/java/docs/reference/pgadapter/latest/com.google.cloud.spanner.pgadapter.metadata.OptionsMetadata#com_google_cloud_spanner_pgadapter_metadata_OptionsMetadata_newBuilder__) to create an options builder, and then call Builder#build() instead of using this constructor.*\n\n### OptionsMetadata(String\\[\\] args)\n\n public OptionsMetadata(String[] args)\n\nCreates a new instance of [OptionsMetadata](/java/docs/reference/pgadapter/latest/com.google.cloud.spanner.pgadapter.metadata.OptionsMetadata) from the given arguments.\n\nIt is recommended to use [#newBuilder()](/java/docs/reference/pgadapter/latest/com.google.cloud.spanner.pgadapter.metadata.OptionsMetadata#com_google_cloud_spanner_pgadapter_metadata_OptionsMetadata_newBuilder__) to create an options Builder instead\nof calling this method directly.\n\nMethods\n-------\n\n### buildConnectionURL(String database)\n\n public String buildConnectionURL(String database)\n\nTakes user inputs and builds a JDBC connection string from them.\n\n### buildCredentialsFile()\n\n public String buildCredentialsFile()\n\nGet credential file path from either command line or application default. If neither are set,\nthen throw an error.\n\n### disableLocalhostCheck()\n\n public boolean disableLocalhostCheck()\n\n### getCommandMetadataJSON()\n\n public JSONObject getCommandMetadataJSON()\n\n### getConnectionURL() (deprecated)\n\n public String getConnectionURL()\n\n**Deprecated.** *use [#getDefaultConnectionUrl()](/java/docs/reference/pgadapter/latest/com.google.cloud.spanner.pgadapter.metadata.OptionsMetadata#com_google_cloud_spanner_pgadapter_metadata_OptionsMetadata_getDefaultConnectionUrl__)*\n\n### getCredentials()\n\n public Credentials getCredentials()\n\nReturns the Credentials instance that has been set for this [OptionsMetadata](/java/docs/reference/pgadapter/latest/com.google.cloud.spanner.pgadapter.metadata.OptionsMetadata).\nThis overrides both any credentials file and any default credentials in the current runtime\nenvironment.\n\n### getDatabaseName(String database)\n\n public DatabaseName getDatabaseName(String database)\n\nReturns the fully qualified database name based on the given database id or name.\n\n### getDdlTransactionMode()\n\n public OptionsMetadata.DdlTransactionMode getDdlTransactionMode()\n\n### getDefaultConnectionUrl()\n\n public String getDefaultConnectionUrl()\n\nReturns the default connection URL that is used by the server. If a default connection URL has\nbeen set, the database parameter in a connection request will be ignored, and the database in\nthis connection URL will be used instead.\n\n### getDefaultDatabaseId()\n\n public DatabaseId getDefaultDatabaseId()\n\nReturns the id of the default database or null if no default has been selected.\n\n### getDefaultInstanceId()\n\n public InstanceId getDefaultInstanceId()\n\nReturns the id of the default instance or null if no default has been selected.\n\n### getMaxBacklog()\n\n public int getMaxBacklog()\n\n### getOpenTelemetryTraceRatio()\n\n public Double getOpenTelemetryTraceRatio()\n\n### getPropertyMap()\n\n public Map\u003cString,String\u003e getPropertyMap()\n\n### getProxyPort()\n\n public int getProxyPort()\n\n### getServerVersion()\n\n public String getServerVersion()\n\n### getServerVersionNum()\n\n public String getServerVersionNum()\n\n### getSessionPoolOptions()\n\n public SessionPoolOptions getSessionPoolOptions()\n\nReturns the SessionPoolOptions that has been set for this [OptionsMetadata](/java/docs/reference/pgadapter/latest/com.google.cloud.spanner.pgadapter.metadata.OptionsMetadata).\n\n### getSocketFile(int localPort)\n\n public String getSocketFile(int localPort)\n\n### getSslMode()\n\n public OptionsMetadata.SslMode getSslMode()\n\n### getTelemetryCredentials()\n\n public Credentials getTelemetryCredentials()\n\n### getTelemetryProjectId()\n\n public String getTelemetryProjectId()\n\n### getTextFormat()\n\n public OptionsMetadata.TextFormat getTextFormat()\n\n### hasDefaultConnectionUrl()\n\n public boolean hasDefaultConnectionUrl()\n\n### hasDefaultInstanceId()\n\n public boolean hasDefaultInstanceId()\n\nReturns true if these options contain a default instance id.\n\n### isBinaryFormat()\n\n public boolean isBinaryFormat()\n\n### isDebugMode()\n\n public boolean isDebugMode()\n\n### isDomainSocketEnabled()\n\n public boolean isDomainSocketEnabled()\n\n### isEnableOpenTelemetry()\n\n public boolean isEnableOpenTelemetry()\n\n### isReplaceJdbcMetadataQueries()\n\n public boolean isReplaceJdbcMetadataQueries()\n\n### isWindows()\n\n public boolean isWindows()\n\nReturns true if the OS is Windows.\n\n### replacePgCatalogTables()\n\n public boolean replacePgCatalogTables()\n\n### requiresMatcher()\n\n public boolean requiresMatcher()\n\n### shouldAuthenticate()\n\n public boolean shouldAuthenticate()\n\n### shouldAutoDetectClient()\n\n public boolean shouldAutoDetectClient()\n\n### useDefaultLocalStatements()\n\n public boolean useDefaultLocalStatements()"]]
