io.greptime.models

Class TableSchema

java.lang.Object

io.greptime.models.TableSchema

public class TableSchema
extends Object

Defines the schema structure for writing data to the database.

For optimal performance, it is recommended to cache and reuse the same TableSchema instance when writing data multiple times. The caching responsibility is delegated to the user since the Ingester client aims to minimize memory overhead by avoiding cache management.

Example usage:

 TableSchema schema = TableSchema.newBuilder("my_table")
     .addTag("tag1", DataType.String)
     .addTimestamp("ts", DataType.TimestampMillisecond)
     .addField("field1", DataType.Float64)
     .build();

 Table table = Table.from(schema);
 // The order of the values must match the schema definition.
 table.addRow(tag_value_1, now, field_value_1);
 table.addRow(tag_value_2, now, field_value_2);
 table.complete();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TableSchema.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	getColumnNames()
List<io.greptime.v1.Common.ColumnDataTypeExtension>	getDataTypeExtensions()
List<io.greptime.v1.Common.ColumnDataType>	getDataTypes()
List<io.greptime.v1.Common.SemanticType>	getSemanticTypes()
String	getTableName()
static TableSchema.Builder	newBuilder(String tableName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getTableName

public String getTableName()

getColumnNames

public List<String> getColumnNames()

getSemanticTypes

public List<io.greptime.v1.Common.SemanticType> getSemanticTypes()

getDataTypes

public List<io.greptime.v1.Common.ColumnDataType> getDataTypes()

getDataTypeExtensions

public List<io.greptime.v1.Common.ColumnDataTypeExtension> getDataTypeExtensions()

newBuilder

public static TableSchema.Builder newBuilder(String tableName)