oracle.pg.rdbms.pgql

Interface PgqlColumnDescriptor

public interface PgqlColumnDescriptor

Describes the metadata for a logical column in a PGQL query result.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PgqlColumnDescriptor.Type Types of logical return columns

Method Summary

Modifier and Type	Method and Description
java.lang.String	getColName() Returns the name of this column.
PgqlColumnDescriptor.Type	getColType() Returns the column type.
int	getSqlOffset() Returns the SQL column starting position of this logical PGQL column in the column list of the SQL translation.

Method Detail

getColName

java.lang.String getColName()

Returns the name of this column.

Returns:

the column name

getColType

PgqlColumnDescriptor.Type getColType()

Returns the column type.

PgqlColumnDescriptor.Type.VERTEX for a vertex
PgqlColumnDescriptor.Type.EDGE for an edge
PgqlColumnDescriptor.Type.VALUE for a property value

Returns:

the column type

getSqlOffset

int getSqlOffset()

Returns the SQL column starting position of this logical PGQL column in the column list of the SQL translation.

PgqlColumnDescriptor.Type.VERTEX and PgqlColumnDescriptor.Type.EDGE PGQL columns have two corresponding SQL columns (column_name$IT, column_name$ID).

PgqlColumnDescriptor.Type.VALUE PGQL columns have four corresponding SQL columns (column_name$T, column_name$V, column_name$VN, column_name$VT).

The offset starts from 1. That is, the first PGQL column has an offset of 1.

Returns:

the starting position of this logical PGQL column in the return columns of the SQL translation