Interface CopyRecord (0.22.1)

public interface CopyRecord

CopyRecord is a common interface for COPY data records that are produced by a parser for a specific COPY format.

Methods

getValue(Type type, int columnIndex)

public abstract Value getValue(Type type, int columnIndex)

Returns the value of the given column as a Cloud Spanner Value of the given type. This method is used by a COPY ... FROM ... operation to convert a value to the type of the column where it is being inserted. This method is supported for all types of CopyRecord.

Parameters
Name	Description
`type`	`com.google.cloud.spanner.Type`
`columnIndex`	`int`

Returns
Type	Description
`com.google.cloud.spanner.Value`

getValue(Type type, String columnName)

public abstract Value getValue(Type type, String columnName)

Parameters
Name	Description
`type`	`com.google.cloud.spanner.Type`
`columnName`	`String`

Returns
Type	Description
`com.google.cloud.spanner.Value`

hasColumnNames()

public abstract boolean hasColumnNames()

Returns true if the copy record has column names. The #getValue(Type, String) method can only be used for records that have column names.

Returns
Type	Description
`boolean`

isEndRecord()

public abstract boolean isEndRecord()

Returns true if this record is the PG end record (.).

Returns
Type	Description
`boolean`

isNull(int columnIndex)

public abstract boolean isNull(int columnIndex)

Returns true if the value of the given column is null.

Parameter
Name	Description
`columnIndex`	`int`

Returns
Type	Description
`boolean`

numColumns()

public abstract int numColumns()

Returns the number of columns in the record.

Returns
Type	Description
`int`