Retrieve a stream

Get(ctx context.Context) (*Stream, error)

Reads the named stream’s registration. It does not create a missing stream or change an existing stream’s settings or messages.

Example

Read the payments.requested stream using an initialized client. RawPayload avoids declaring a payload type for this registration lookup.

payments := client.Stream[sqlstreams.RawPayload]("payments.requested")
stream, err := payments.Get(ctx)
if err != nil {
  return err
}
if stream == nil {
  return errors.New("payments.requested is not registered")
}
fmt.Println(stream.Id, stream.RetentionTTL)

Parameters

Returns

CLI

sqlstreams stream get payments.requested

Prints the registration and exits with status 0 when found. An absent stream prints an absence message and exits with status 1. See stream commands for output formats and flags.

Errors

Related topics

• The stream object — Returned fields.
• Register a stream — Create or update a registration.