Class CopyStatement (0.25.0) 

publicclass CopyStatementextendsIntermediatePortalStatement

CopyStatement models a COPY table FROM STDIN statement. The same class is used both as an IntermediatePreparedStatement and IntermediatePortalStatement, as COPY does not support any statement parameters, which means that there is no difference between the two.

Inherited Members

Static Methods

create(ConnectionHandler connectionHandler, OptionsMetadata options, String name, AbstractStatementParser.ParsedStatement parsedStatement, Statement originalStatement)

publicstaticIntermediatePortalStatementcreate(ConnectionHandlerconnectionHandler,OptionsMetadataoptions,Stringname,AbstractStatementParser.ParsedStatementparsedStatement,StatementoriginalStatement)
Parameters
Name Description
connectionHandler ConnectionHandler
options OptionsMetadata
name String
parsedStatement ParsedStatement
originalStatement com.google.cloud.spanner.Statement
Returns
Type Description
IntermediatePortalStatement

Constructors

CopyStatement(ConnectionHandler connectionHandler, OptionsMetadata options, String name, AbstractStatementParser.ParsedStatement parsedStatement, Statement originalStatement, CopyStatement.ParsedCopyStatement parsedCopyStatement)

publicCopyStatement(ConnectionHandlerconnectionHandler,OptionsMetadataoptions,Stringname,AbstractStatementParser.ParsedStatementparsedStatement,StatementoriginalStatement,CopyStatement.ParsedCopyStatementparsedCopyStatement)
Parameters
Name Description
connectionHandler ConnectionHandler
options OptionsMetadata
name String
parsedStatement ParsedStatement
originalStatement com.google.cloud.spanner.Statement
parsedCopyStatement com.google.cloud.spanner.pgadapter.statements.CopyStatement.ParsedCopyStatement

Methods

close()

publicvoidclose()

Cleanly close the statement. Does nothing if the statement has not been executed or has no result.

Overrides
Exceptions
Type Description
Exception

createPortal(String name, byte[][] parameters, List<Short> parameterFormatCodes, List<Short> resultFormatCodes)

publicIntermediatePortalStatementcreatePortal(Stringname,byte[][]parameters,List<Short>parameterFormatCodes,List<Short>resultFormatCodes)

Creates a portal from this statement.

Parameters
Name Description
name String
parameters byte[][]
parameterFormatCodes List<Short>
resultFormatCodes List<Short>
Returns
Type Description
IntermediatePortalStatement
Overrides

executeAsync(BackendConnection backendConnection)

publicvoidexecuteAsync(BackendConnectionbackendConnection)
Parameter
Name Description
backendConnection BackendConnection
Overrides

getCopyColumnNames()

publicList<SimpleParser.TableOrIndexName>getCopyColumnNames()
Returns
Type Description
List<com.google.cloud.spanner.pgadapter.statements.SimpleParser.TableOrIndexName>

List of column names specified in COPY statement, if provided.

getDelimiterChar()

publicchargetDelimiterChar()
Returns
Type Description
char

Delimiter character specified in COPY statement, if provided.

getEscapeChar()

publicchargetEscapeChar()
Returns
Type Description
char

Escape character specified in COPY statement, if provided.

getFormatCode()

publicbytegetFormatCode()
Returns
Type Description
byte

0 for text/csv formatting and 1 for binary

getFormatType()

publicStringgetFormatType()
Returns
Type Description
String

Format type specified in COPY statement, if provided.

getMutationWriter()

publicMutationWritergetMutationWriter()
Returns
Type Description
MutationWriter

getNullString()

publicStringgetNullString()
Returns
Type Description
String

Null string specified in COPY statement, if provided.

getParserFormat()

publicCSVFormatgetParserFormat()
Returns
Type Description
org.apache.commons.csv.CSVFormat

getQuoteChar()

publicchargetQuoteChar()
Returns
Type Description
char

Quote character specified in COPY statement, if provided.

getStatementType()

publicAbstractStatementParser.StatementTypegetStatementType()
Returns
Type Description
StatementType
Overrides

getTableColumns()

publicMap<String,Type>getTableColumns()
Returns
Type Description
Map<String,com.google.cloud.spanner.Type>

Mapping of table column names to column type.

getTableName()

publicSimpleParser.TableOrIndexNamegetTableName()
Returns
Type Description
com.google.cloud.spanner.pgadapter.statements.SimpleParser.TableOrIndexName

getUpdateCount()

publiclonggetUpdateCount()
Returns
Type Description
long
Overrides

hasException()

publicbooleanhasException()
Returns
Type Description
boolean
Overrides

hasHeader()

publicbooleanhasHeader()
Returns
Type Description
boolean

True if copy data contains a header, false otherwise.

setParserFormat(CopyStatement.ParsedCopyStatement parsedCopyStatement)

publicvoidsetParserFormat(CopyStatement.ParsedCopyStatementparsedCopyStatement)

CSVFormat for parsing copy data based on COPY statement options specified.

Parameter
Name Description
parsedCopyStatement com.google.cloud.spanner.pgadapter.statements.CopyStatement.ParsedCopyStatement

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.