Class TableDescriptor

TableDescriptor describes an ORM table.

Generated

from message cosmos.orm.v1.TableDescriptor

Hierarchy

Message<TableDescriptor>
- TableDescriptor

Index

Constructors

constructor

new TableDescriptor(data?): TableDescriptor
Parameters
- Optionaldata: PartialMessage<TableDescriptor>
Returns TableDescriptor
Overrides Message<TableDescriptor>.constructor
- Defined in src/proto/cosmos/orm/v1/orm_pb.ts:38

Properties

id

id: number = 0

id is a non-zero integer ID that must be unique within the tables and singletons in this file. It may be deprecated in the future when this can be auto-generated.

Generated

from field: uint32 id = 3;

index

index: SecondaryIndexDescriptor[] = []

index defines one or more secondary indexes.

Generated

from field: repeated cosmos.orm.v1.SecondaryIndexDescriptor index = 2;

`Optional`primaryKey

primaryKey?: PrimaryKeyDescriptor

primary_key defines the primary key for the table.

Generated

from field: cosmos.orm.v1.PrimaryKeyDescriptor primary_key = 1;

`Static` `Readonly`fields

fields: FieldList = ...

`Static` `Readonly`runtime

runtime: ProtoRuntime = proto3

`Static` `Readonly`typeName

typeName: "cosmos.orm.v1.TableDescriptor" = "cosmos.orm.v1.TableDescriptor"

Methods

`Static`equals

equals(a, b): boolean
Parameters
- a: undefined | TableDescriptor | PlainMessage<TableDescriptor>
- b: undefined | TableDescriptor | PlainMessage<TableDescriptor>
Returns boolean
- Defined in src/proto/cosmos/orm/v1/orm_pb.ts:63

`Static`fromBinary

fromBinary(bytes, options?): TableDescriptor
Parameters
- bytes: Uint8Array
- Optionaloptions: Partial<BinaryReadOptions>
Returns TableDescriptor
- Defined in src/proto/cosmos/orm/v1/orm_pb.ts:51

`Static`fromJson

fromJson(jsonValue, options?): TableDescriptor
Parameters
- jsonValue: JsonValue
- Optionaloptions: Partial<JsonReadOptions>
Returns TableDescriptor
- Defined in src/proto/cosmos/orm/v1/orm_pb.ts:55

`Static`fromJsonString

fromJsonString(jsonString, options?): TableDescriptor
Parameters
- jsonString: string
- Optionaloptions: Partial<JsonReadOptions>
Returns TableDescriptor
- Defined in src/proto/cosmos/orm/v1/orm_pb.ts:59

Class TableDescriptor

Generated

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TableDescriptor

Properties

id

Generated

index

Generated

`Optional`primaryKey

Generated

`Static` `Readonly`fields

`Static` `Readonly`runtime

`Static` `Readonly`typeName

Methods

`Static`equals

Parameters

Returns boolean

`Static`fromBinary

Parameters

Returns TableDescriptor

`Static`fromJson

Parameters

Returns TableDescriptor

`Static`fromJsonString

Parameters

Returns TableDescriptor

Settings

On This Page

Class TableDescriptor

Generated

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TableDescriptor

Properties

id

Generated

index

Generated

OptionalprimaryKey

Generated

Static Readonlyfields

Static Readonlyruntime

Static ReadonlytypeName

Methods

Staticequals

Parameters

Returns boolean

StaticfromBinary

Parameters

Returns TableDescriptor

StaticfromJson

Parameters

Returns TableDescriptor

StaticfromJsonString

Parameters

Returns TableDescriptor

Settings

On This Page

`Optional`primaryKey

`Static` `Readonly`fields

`Static` `Readonly`runtime

`Static` `Readonly`typeName

`Static`equals

`Static`fromBinary

`Static`fromJson

`Static`fromJsonString