Retrieve the system

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

Reads the installation selected by the client’s Schema. It does not create the installation or change its settings.

Example

Use an initialized client.

system, err := client.System().Get(ctx)
if err != nil {
  return err
}
if system == nil {
  return errors.New("SQLStreams system is not registered")
}
fmt.Println(system.Id, system.CreatedAt)

Parameters

Parameter	Type	Required	Description
`ctx`	`context.Context`	Yes	Cancellation or its deadline interrupts the database read.

Returns

Condition	Return value
System is registered	`(system, nil)`, where system is the system object.
System is absent	`(nil, nil)`.
Read fails	`(nil, err)`.

CLI

sqlstreams system get

Prints the system timestamps and exits with status 0 when registered. Absence exits with status 1. See system commands for output formats and flags.

Errors

Error	When
Database error	The system row cannot be read.
Context cancellation or deadline error	The read is interrupted by its context.

Register the system — Create or redeclare the installation.
The system object — Returned fields.

Example

Parameters

Returns

CLI

Errors

Related topics