Class OptionsMetadata (0.6.1)

Version 0.6.1

• 0.27.1 (latest)
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.1
• 0.22.1
• 0.21.0
• 0.20.0
• 0.19.1
• 0.18.4
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.1
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.1
• 0.5.1

public class OptionsMetadata

Metadata extractor for CLI.

Inheritance

java.lang.Object > OptionsMetadata

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

OptionsMetadata(String defaultConnectionUrl, int proxyPort, OptionsMetadata.TextFormat textFormat, boolean forceBinary, boolean authenticate, boolean requiresMatcher, boolean replaceJdbcMetadataQueries, JSONObject commandMetadata)

public OptionsMetadata(String defaultConnectionUrl, int proxyPort, OptionsMetadata.TextFormat textFormat, boolean forceBinary, boolean authenticate, boolean requiresMatcher, boolean replaceJdbcMetadataQueries, JSONObject commandMetadata)

Parameters

Name	Description
defaultConnectionUrl	String
proxyPort	int
textFormat	OptionsMetadata.TextFormat
forceBinary	boolean
authenticate	boolean
requiresMatcher	boolean
replaceJdbcMetadataQueries	boolean
commandMetadata	org.json.simple.JSONObject

OptionsMetadata(String[] args)

public OptionsMetadata(String[] args)

Parameter

Name	Description
args	String[]

Methods

buildConnectionURL(String database)

public String buildConnectionURL(String database)

Takes user inputs and builds a JDBC connection string from them.

Parameter

Name	Description
database	String

Returns

Type	Description
String	The parsed JDBC connection string.

buildCredentialsFile()

public String buildCredentialsFile()

Get credential file path from either command line or application default. If neither throw error.

Returns

Type	Description
String	The absolute path of the credentials file.

disableLocalhostCheck()

public boolean disableLocalhostCheck()

Returns

Type	Description
boolean

getCommandMetadataJSON()

public JSONObject getCommandMetadataJSON()

Returns

Type	Description
org.json.simple.JSONObject

getConnectionURL() (deprecated)

public String getConnectionURL()

Deprecated. use #getDefaultConnectionUrl()

Returns

Type	Description
String	the default connection URL that is used by the server.

getDatabaseName(String database)

public DatabaseName getDatabaseName(String database)

Returns the fully qualified database name based on the given database id or name.

Parameter

Name	Description
database	String

Returns

Type	Description
com.google.spanner.v1.DatabaseName

getDdlTransactionMode()

public OptionsMetadata.DdlTransactionMode getDdlTransactionMode()

Returns

Type	Description
OptionsMetadata.DdlTransactionMode

getDefaultConnectionUrl()

public String getDefaultConnectionUrl()

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.

Returns

Type	Description
String	the default connection URL that is used by the server.

getDefaultDatabaseId()

public DatabaseId getDefaultDatabaseId()

Returns the id of the default database or null if no default has been selected.

Returns

Type	Description
com.google.cloud.spanner.DatabaseId

getDefaultInstanceId()

public InstanceId getDefaultInstanceId()

Returns the id of the default instance or null if no default has been selected.

Returns

Type	Description
com.google.cloud.spanner.InstanceId

getMaxBacklog()

public int getMaxBacklog()

Returns

Type	Description
int

getPropertyMap()

public Map<String,String> getPropertyMap()

Returns

Type	Description
Map<String,String>

getProxyPort()

public int getProxyPort()

Returns

Type	Description
int

getServerVersion()

public String getServerVersion()

Returns

Type	Description
String

getSocketFile(int localPort)

public String getSocketFile(int localPort)

Parameter

Name	Description
localPort	int

Returns

Type	Description
String

getTextFormat()

public OptionsMetadata.TextFormat getTextFormat()

Returns

Type	Description
OptionsMetadata.TextFormat

hasDefaultConnectionUrl()

public boolean hasDefaultConnectionUrl()

Returns

Type	Description
boolean	true if the server uses a default connection URL and ignores the database in a connection request

hasDefaultInstanceId()

public boolean hasDefaultInstanceId()

Returns true if these options contain a default instance id.

Returns

Type	Description
boolean

isBinaryFormat()

public boolean isBinaryFormat()

Returns

Type	Description
boolean

isDebugMode()

public boolean isDebugMode()

Returns

Type	Description
boolean

isDomainSocketEnabled()

public boolean isDomainSocketEnabled()

Returns

Type	Description
boolean

isReplaceJdbcMetadataQueries()

public boolean isReplaceJdbcMetadataQueries()

Returns

Type	Description
boolean

isWindows()

public boolean isWindows()

Returns true if the OS is Windows.

Returns

Type	Description
boolean

requiresMatcher()

public boolean requiresMatcher()

Returns

Type	Description
boolean

shouldAuthenticate()

public boolean shouldAuthenticate()

Returns

Type	Description
boolean

shouldAutoDetectClient()

public boolean shouldAutoDetectClient()

Returns

Type	Description
boolean