Restate introspection SQL API reference #107
Conversation
✅ Deploy Preview for docsrestatedev ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Thanks for creating this PR @gvdongen. I stumbled upon two minor question when I tried merging this PR. Maybe @igalshilman you know more because you were more in the loop. Once they are resolved, I think we should merge this PR.
| | `service_key_utf8` | `utf8` | Only contains meaningful values when a service uses a `utf8` Restate key | `bob` | | ||
| | `service_key_int32` | `Int32` | Only contains meaningful values when a service uses an `int32` Restate key | `1337` | | ||
| | `service_key_uuid` | `utf8` | Only contains meaningful values for unkeyed Restate services | `0189bab3b3397d828e979e2548980fa6` | |
There was a problem hiding this comment.
Did we deliberately leave out the service_key column because it is not useful for users? Do you maybe know more @igalshilman?
There was a problem hiding this comment.
It is indeed less useful, not sure if it wasn't included because of that. You can include for a more complete reference if you wish.
A possible description: a binary, uninterpreted representation of the service key. You can use a more specific column based on the type of your key, such as service_key_utf8 (for string keys), serivce_key_uuid for unkeyed services, or service_key_int32 for integer keys.
| | `invoked_by_service` | `utf8` | The name of the invoking service. Or `null` if invoked via the ingress. | `com.example.Greeter` | | ||
| | `invoked_by_sid` | `utf8` | The service invocation ID of the service that triggered this invocation. Or `null` if invoked via the ingress. | | | ||
| | `trace_id` | `utf8` | The ID of the trace that is assigned to this invocation. Only relevant when tracing is enabled. | | | ||
| | `journal_size` | `uint32` | The number of journal entries durably logged for this invocation | | |
There was a problem hiding this comment.
| | `journal_size` | `uint32` | The number of journal entries durably logged for this invocation | | | |
| | `journal_size` | `UInt32` | The number of journal entries durably logged for this invocation | | |
| | `service_key_uuid` | `utf8` | Only contains meaningful values for unkeyed Restate services | `0189bab3b3397d828e979e2548980fa6` | | ||
| | `key` | `utf8` | The `utf8` user-supplied state key | A snippet like `ctx.set(“seen”, 1);` Will produce a value like: `seen` | | ||
| | `value_utf8` | `utf8` | Only contains meaningful values when a service stores state as `utf8`. This is the case for Typescript services since the Typescript SDK serializes values as JSON. | `1` | | ||
| | `value` | | | | |
There was a problem hiding this comment.
Is it intended to not further specify the value column because value_utf8 will only be used by our users? Do you maybe know more @igalshilman?
There was a problem hiding this comment.
Same answer as for the other table :-)
Fixes #104
sys_statusandstate@igalshilman This is the markdown version of the table you sent me. Let me know if something should be changed.