Class CopyStatement (0.15.0)
Stay organized with collections
Save and categorize content based on your preferences.
public class CopyStatement extends IntermediatePortalStatement
Static Methods
public static IntermediatePortalStatement create(ConnectionHandler connectionHandler, OptionsMetadata options, String name, AbstractStatementParser.ParsedStatement parsedStatement, Statement originalStatement)
Parameters
Returns
Constructors
public CopyStatement(ConnectionHandler connectionHandler, OptionsMetadata options, String name, AbstractStatementParser.ParsedStatement parsedStatement, Statement originalStatement, CopyStatement.ParsedCopyStatement parsedCopyStatement)
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()
Cleanly close the statement. Does nothing if the statement has not been executed or has no
result.
Overrides
Exceptions
createPortal(String name, byte[][] parameters, List<Short> parameterFormatCodes, List<Short> resultFormatCodes)
public IntermediatePortalStatement createPortal(String name, byte[][] parameters, List<Short> parameterFormatCodes, List<Short> resultFormatCodes)
Creates a portal from this statement.
Parameters
Returns
Overrides
executeAsync(BackendConnection backendConnection)
public void executeAsync(BackendConnection backendConnection)
Parameter
Overrides
getCopyColumnNames()
public List<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()
public char getDelimiterChar()
Returns
| Type |
Description |
char |
Delimiter character specified in COPY statement, if provided.
|
getEscapeChar()
public char getEscapeChar()
Returns
| Type |
Description |
char |
Escape character specified in COPY statement, if provided.
|
public int getFormatCode()
Returns
| Type |
Description |
int |
0 for text/csv formatting and 1 for binary
|
public String getFormatType()
Returns
| Type |
Description |
String |
Format type specified in COPY statement, if provided.
|
getMutationWriter()
public MutationWriter getMutationWriter()
Returns
getNullString()
public String getNullString()
Returns
| Type |
Description |
String |
Null string specified in COPY statement, if provided.
|
public CSVFormat getParserFormat()
Returns
| Type |
Description |
org.apache.commons.csv.CSVFormat |
|
getQuoteChar()
public char getQuoteChar()
Returns
| Type |
Description |
char |
Quote character specified in COPY statement, if provided.
|
getStatementType()
public AbstractStatementParser.StatementType getStatementType()
Returns
Overrides
getTableColumns()
public Map<String,Type> getTableColumns()
Returns
| Type |
Description |
Map<String,com.google.cloud.spanner.Type> |
Mapping of table column names to column type.
|
getTableName()
public SimpleParser.TableOrIndexName getTableName()
Returns
| Type |
Description |
com.google.cloud.spanner.pgadapter.statements.SimpleParser.TableOrIndexName |
|
getUpdateCount()
public long getUpdateCount()
Returns
Overrides
hasException()
public boolean hasException()
Returns
Overrides
public boolean hasHeader()
Returns
| Type |
Description |
boolean |
True if copy data contains a header, false otherwise.
|
public void setParserFormat(CopyStatement.ParsedCopyStatement parsedCopyStatement)
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 2026-03-09 UTC.
[null,null,["Last updated 2026-03-09 UTC."],[],[]]