io.asyncer.r2dbc.mysql.collation

Interface CharCollation

public interface CharCollation

Character collation of MySQL.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BINARY_ID The binary collation.

Method Summary

Modifier and Type	Method and Description
static CharCollation	clientCharCollation() WARNING: this method is internal method in `r2dbc-mysql`, it is UNSTABLE and may change.
static CharCollation	fromId(int id, ServerVersion version) Obtain an instance of CharCollation from the identifier and server version, if not found, it will fallback to UTF-8.
int	getByteSize() Get the maximum byte width/size of the character collation.
Charset	getCharset() Get the most suitable character set.
int	getId() Get the character collation identifier.
String	getName() Get the name of the character collation.

Field Detail

BINARY_ID

static final int BINARY_ID

The binary collation. It means that no character set or collation is contained.

Method Detail

getId

int getId()

Get the character collation identifier.

Returns:

the identifier.

getName

String getName()

Get the name of the character collation.

Returns:

the name.

getByteSize

int getByteSize()

Get the maximum byte width/size of the character collation.

Returns:

the maximum byte width/size.

getCharset

Charset getCharset()

Get the most suitable character set.

Returns:

the most suitable Charset.

fromId

static CharCollation fromId(int id,
                            ServerVersion version)

Obtain an instance of CharCollation from the identifier and server version, if not found, it will fallback to UTF-8. (i.e. utf8mb4)

Parameters:

id - character collation identifier.

version - the version of MySQL server.

Returns:

the CharCollation.

Throws:

IllegalArgumentException - if version is null.

clientCharCollation

static CharCollation clientCharCollation()

WARNING: this method is internal method in `r2dbc-mysql`, it is UNSTABLE and may change.

Returns:

client character collation.