com.mysql.cj.x.protobuf

Interface MysqlxResultset.ColumnMetaDataOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

MysqlxResultset.ColumnMetaData, MysqlxResultset.ColumnMetaData.Builder

Enclosing class:

MysqlxResultset

public static interface MysqlxResultset.ColumnMetaDataOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
com.google.protobuf.ByteString	getCatalog() catalog the schema originates from @note As there is currently no support for catalogs in MySQL, don't expect this field to be set.
long	getCollation() optional uint64 collation = 8;
int	getContentType() a hint about the higher-level encoding of a BYTES field | Type | Value | Description | |--------|--------|-------------------------| | BYTES | 0x0001 | GEOMETRY (WKB encoding) | | BYTES | 0x0002 | JSON (text encoding) | | BYTES | 0x0003 | XML (text encoding) | @note This list isn't comprehensive.
int	getFlags() ``.type`` specific flags | Type | Value | Description | |---------|--------|--------------| | UINT | 0x0001 | zerofill | | DOUBLE | 0x0001 | unsigned | | FLOAT | 0x0001 | unsigned | | DECIMAL | 0x0001 | unsigned | | BYTES | 0x0001 | rightpad | | Value | Description | |--------|-----------------| | 0x0010 | NOT\_NULL | | 0x0020 | PRIMARY\_KEY | | 0x0040 | UNIQUE\_KEY | | 0x0080 | MULTIPLE\_KEY | | 0x0100 | AUTO\_INCREMENT | default: 0
int	getFractionalDigits() displayed factional decimal digits for floating point and fixed point numbers
int	getLength() maximum count of displayable characters of .type
com.google.protobuf.ByteString	getName() name of the column
com.google.protobuf.ByteString	getOriginalName() name of the column before an alias was applied
com.google.protobuf.ByteString	getOriginalTable() name of the table the column originates from before an alias was applied
com.google.protobuf.ByteString	getSchema() schema the column originates from
com.google.protobuf.ByteString	getTable() name of the table the column originates from
MysqlxResultset.ColumnMetaData.FieldType	getType() datatype of the field in a row
boolean	hasCatalog() catalog the schema originates from @note As there is currently no support for catalogs in MySQL, don't expect this field to be set.
boolean	hasCollation() optional uint64 collation = 8;
boolean	hasContentType() a hint about the higher-level encoding of a BYTES field | Type | Value | Description | |--------|--------|-------------------------| | BYTES | 0x0001 | GEOMETRY (WKB encoding) | | BYTES | 0x0002 | JSON (text encoding) | | BYTES | 0x0003 | XML (text encoding) | @note This list isn't comprehensive.
boolean	hasFlags() ``.type`` specific flags | Type | Value | Description | |---------|--------|--------------| | UINT | 0x0001 | zerofill | | DOUBLE | 0x0001 | unsigned | | FLOAT | 0x0001 | unsigned | | DECIMAL | 0x0001 | unsigned | | BYTES | 0x0001 | rightpad | | Value | Description | |--------|-----------------| | 0x0010 | NOT\_NULL | | 0x0020 | PRIMARY\_KEY | | 0x0040 | UNIQUE\_KEY | | 0x0080 | MULTIPLE\_KEY | | 0x0100 | AUTO\_INCREMENT | default: 0
boolean	hasFractionalDigits() displayed factional decimal digits for floating point and fixed point numbers
boolean	hasLength() maximum count of displayable characters of .type
boolean	hasName() name of the column
boolean	hasOriginalName() name of the column before an alias was applied
boolean	hasOriginalTable() name of the table the column originates from before an alias was applied
boolean	hasSchema() schema the column originates from
boolean	hasTable() name of the table the column originates from
boolean	hasType() datatype of the field in a row

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasType

boolean hasType()

 datatype of the field in a row 
 

required .Mysqlx.Resultset.ColumnMetaData.FieldType type = 1;

Returns:

Whether the type field is set.

getType

MysqlxResultset.ColumnMetaData.FieldType getType()

 datatype of the field in a row 
 

required .Mysqlx.Resultset.ColumnMetaData.FieldType type = 1;

Returns:

The type.

hasName

boolean hasName()

 name of the column 
 

optional bytes name = 2;

Returns:

Whether the name field is set.

getName

com.google.protobuf.ByteString getName()

 name of the column 
 

optional bytes name = 2;

Returns:

The name.

hasOriginalName

boolean hasOriginalName()

 name of the column before an alias was applied 
 

optional bytes original_name = 3;

Returns:

Whether the originalName field is set.

getOriginalName

com.google.protobuf.ByteString getOriginalName()

 name of the column before an alias was applied 
 

optional bytes original_name = 3;

Returns:

The originalName.

hasTable

boolean hasTable()

 name of the table the column originates from 
 

optional bytes table = 4;

Returns:

Whether the table field is set.

getTable

com.google.protobuf.ByteString getTable()

 name of the table the column originates from 
 

optional bytes table = 4;

Returns:

The table.

hasOriginalTable

boolean hasOriginalTable()

 name of the table the column originates from before an alias was applied 
 

optional bytes original_table = 5;

Returns:

Whether the originalTable field is set.

getOriginalTable

com.google.protobuf.ByteString getOriginalTable()

 name of the table the column originates from before an alias was applied 
 

optional bytes original_table = 5;

Returns:

The originalTable.

hasSchema

boolean hasSchema()

 schema the column originates from 
 

optional bytes schema = 6;

Returns:

Whether the schema field is set.

getSchema

com.google.protobuf.ByteString getSchema()

 schema the column originates from 
 

optional bytes schema = 6;

Returns:

The schema.

hasCatalog

boolean hasCatalog()

 catalog the schema originates from
@note
As there is currently no support for catalogs in MySQL,
don't expect this field to be set. In the MySQL C/S
protocol the field had the value ``def`` all the time 
 

optional bytes catalog = 7;

Returns:

Whether the catalog field is set.

getCatalog

com.google.protobuf.ByteString getCatalog()

 catalog the schema originates from
@note
As there is currently no support for catalogs in MySQL,
don't expect this field to be set. In the MySQL C/S
protocol the field had the value ``def`` all the time 
 

optional bytes catalog = 7;

Returns:

The catalog.

hasCollation

boolean hasCollation()

optional uint64 collation = 8;

Returns:

Whether the collation field is set.

getCollation

long getCollation()

optional uint64 collation = 8;

Returns:

The collation.

hasFractionalDigits

boolean hasFractionalDigits()

 displayed factional decimal digits for floating point and
fixed point numbers 
 

optional uint32 fractional_digits = 9;

Returns:

Whether the fractionalDigits field is set.

getFractionalDigits

int getFractionalDigits()

 displayed factional decimal digits for floating point and
fixed point numbers 
 

optional uint32 fractional_digits = 9;

Returns:

The fractionalDigits.

hasLength

boolean hasLength()

 maximum count of displayable characters of .type 
 

optional uint32 length = 10;

Returns:

Whether the length field is set.

getLength

int getLength()

 maximum count of displayable characters of .type 
 

optional uint32 length = 10;

Returns:

The length.

hasFlags

boolean hasFlags()

 ``.type`` specific flags
| Type    | Value  | Description  |
|---------|--------|--------------|
| UINT    | 0x0001 | zerofill     |
| DOUBLE  | 0x0001 | unsigned     |
| FLOAT   | 0x0001 | unsigned     |
| DECIMAL | 0x0001 | unsigned     |
| BYTES   | 0x0001 | rightpad     |
| Value  | Description     |
|--------|-----------------|
| 0x0010 | NOT\_NULL       |
| 0x0020 | PRIMARY\_KEY    |
| 0x0040 | UNIQUE\_KEY     |
| 0x0080 | MULTIPLE\_KEY   |
| 0x0100 | AUTO\_INCREMENT |
default: 0 
 

optional uint32 flags = 11;

Returns:

Whether the flags field is set.

getFlags

int getFlags()

 ``.type`` specific flags
| Type    | Value  | Description  |
|---------|--------|--------------|
| UINT    | 0x0001 | zerofill     |
| DOUBLE  | 0x0001 | unsigned     |
| FLOAT   | 0x0001 | unsigned     |
| DECIMAL | 0x0001 | unsigned     |
| BYTES   | 0x0001 | rightpad     |
| Value  | Description     |
|--------|-----------------|
| 0x0010 | NOT\_NULL       |
| 0x0020 | PRIMARY\_KEY    |
| 0x0040 | UNIQUE\_KEY     |
| 0x0080 | MULTIPLE\_KEY   |
| 0x0100 | AUTO\_INCREMENT |
default: 0 
 

optional uint32 flags = 11;

Returns:

The flags.

hasContentType

boolean hasContentType()

 a hint about the higher-level encoding of a BYTES field
| Type   | Value  | Description             |
|--------|--------|-------------------------|
| BYTES  | 0x0001 | GEOMETRY (WKB encoding) |
| BYTES  | 0x0002 | JSON (text encoding)    |
| BYTES  | 0x0003 | XML (text encoding)     |
@note
This list isn't comprehensive. As a guideline: the field's
value is expected to pass a validator check on client
and server if this field is set. If the server adds more
internal data types that rely on BLOB storage like image
manipulation, seeking into complex types in BLOBs, and
more types will be added 
 

optional uint32 content_type = 12;

Returns:

Whether the contentType field is set.

getContentType

int getContentType()

 a hint about the higher-level encoding of a BYTES field
| Type   | Value  | Description             |
|--------|--------|-------------------------|
| BYTES  | 0x0001 | GEOMETRY (WKB encoding) |
| BYTES  | 0x0002 | JSON (text encoding)    |
| BYTES  | 0x0003 | XML (text encoding)     |
@note
This list isn't comprehensive. As a guideline: the field's
value is expected to pass a validator check on client
and server if this field is set. If the server adds more
internal data types that rely on BLOB storage like image
manipulation, seeking into complex types in BLOBs, and
more types will be added 
 

optional uint32 content_type = 12;

Returns:

The contentType.