Skip to content

Latest commit

 

History

History
47 lines (38 loc) · 2.95 KB

schema.md

File metadata and controls

47 lines (38 loc) · 2.95 KB
Raw

PSLX uses protobuf to store data. All the schemas are in the folder of schema. In the enums.proto, the following enum types are defined:

  1. ModeType: whether it is in test mode or production mode.
  2. SortOrder: the order of the children nodes and parent nodes in a node.
  3. DataModelType: the data model type for the containers.
  4. InstantMessagingType: the type of instant messaging app.
  5. StorageType: the type of the storage.
  6. ReadRuleType: the read rule for DefaultStorage.
  7. WriteRuleType: the write rule for DefaultStorage and FixedSizeStorage.
  8. PartitionerStorageType: the type of the partitioner.
  9. Status: status of the operator, container, and RPC response.
  10. Signal: signal for internal usage only.

In rpc.proto, RPC-related message types are defined:

  1. GenericRPCService: the generic rpc service supported in PSLX.
  2. HealthCheckerRequest: the health checker request.
  3. HealthCheckerResponse: the health checker response.
  4. GenericRPCRequest: generic request that encapsulates the request message in its Any field.
  5. GenericRPCResponse: generic response that encapsulates the response message in its Any field.
  6. GenericRPCRequestResponsePair: pair of generic request and response.
  7. InstantMessagingRPCRequest: instant messaging rpc request.
  8. EmailPRCRequest: email rpc request.
  9. ProtoViewerRPCRequest: request for proto viewer service.
  10. ProtoViewerRPCResponse: response from proto viewer service.

In snapshots.proto, the snapshots for node, operator and container are defined:

  1. NodeSnapshot: snapshot for node.
  2. OperatorSnapshot: snapshot for operator.
  3. ContainerSnapshot: snapshot for container.
  4. OperatorContentPlain: a plain text representation for content in operator.
  5. OperatorContentList: a list representation for content in operator. 6: OperatorContentDict: a dictionary representation for content in operator

In storage.proto, the proto table storage type and the value for the container backend storage are defined:

  1. ProtoTable: generic storage schema for ProtoTableStorage.
  2. ProtoTableIndexMap: generic format for storing index for ShardedProtoTableStorage.
  3. ContainerBackendValue: the value type for container backend service.

In common.proto, various credential formats are defined:

  1. Credentials: a specifically designed message to storage credentials.
  2. FileInfo: information about a file.
  3. FrontendConfig: the config for frontend.