kurrentdb

KurrentDB client core.

Types

Append

pub type Append {
  AppendSuccess(current_revision: Int, position: Position)
}

Constructors

AppendSuccess(current_revision: Int, position: Position)

AppendOptions

pub type AppendOptions {
  AppendOptions(expected_revision: ExpectedRevision)
}

Constructors

AppendOptions(expected_revision: ExpectedRevision)

Client

pub type Client {
  Client(endpoint: String, tls: Bool)
}

Constructors

```
Client(endpoint: String, tls: Bool)
```

Delete

pub type Delete {
  DeleteSuccess(position: Position)
}

Constructors

```
DeleteSuccess(position: Position)
```

DeleteOptions

pub type DeleteOptions {
  DeleteOptions(expected_revision: ExpectedRevision)
}

Constructors

DeleteOptions(expected_revision: ExpectedRevision)

Direction

pub type Direction {
  Forwards
  Backwards
}

Constructors

```
Forwards
```
```
Backwards
```

Error

pub type Error {
  HttpStatus(Int)
  GrpcStatus(String)
  UnknownGrpcStatus(status: String, message: String)
  EmptyResponse
  ManyResponses
  FrameError(FrameError)
  UnableToDecodeGrpcResponse(List(ProtobufDecodeError))
  UnableToDecodeStreamMetadata(json.DecodeError)
  AppendWrongExpectedVersion
  ReadStreamNotFound(String)
  StreamDeleted(String)
  AccessDenied
  NotAuthenticated
  Unavailable
  DeadlineExceeded
  NotLeader(String)
  UnableToBuildRequest
  StreamFinished
}

Constructors

```
HttpStatus(Int)
```
```
GrpcStatus(String)
```

UnknownGrpcStatus(status: String, message: String)

```
EmptyResponse
```
```
ManyResponses
```
```
FrameError(FrameError)
```

UnableToDecodeGrpcResponse(List(ProtobufDecodeError))

UnableToDecodeStreamMetadata(json.DecodeError)

```
AppendWrongExpectedVersion
```
```
ReadStreamNotFound(String)
```
```
StreamDeleted(String)
```
```
AccessDenied
```
```
NotAuthenticated
```
```
Unavailable
```
```
DeadlineExceeded
```
```
NotLeader(String)
```
```
UnableToBuildRequest
```
```
StreamFinished
```

Event

pub type Event {
  Event(
    id: String,
    type_: String,
    content_type: String,
    data: BitArray,
    metadata: BitArray,
  )
}

Constructors

Event(
  id: String,
  type_: String,
  content_type: String,
  data: BitArray,
  metadata: BitArray,
)

ExpectedRevision

pub type ExpectedRevision {
  Revision(Int)
  NoStream
  Any
  StreamExists
}

Constructors

```
Revision(Int)
```
```
NoStream
```
```
Any
```
```
StreamExists
```

FilterWindow

pub type FilterWindow {
  FilterMax(Int)
  FilterCount
}

Constructors

```
FilterMax(Int)
```
```
FilterCount
```

FrameError

pub type FrameError {
  IncompleteHeader
  CompressedMessage
  IncompleteMessage(expected_bytes: Int)
}

Constructors

```
IncompleteHeader
```
```
CompressedMessage
```
```
IncompleteMessage(expected_bytes: Int)
```

OperationError

pub type OperationError(send_error) {
  SendError(send_error)
  KurrentdbError(Error)
}

Constructors

```
SendError(send_error)
```
```
KurrentdbError(Error)
```

Position

pub type Position {
  NoPositionReturned
  Position(commit_position: Int, prepare_position: Int)
}

Constructors

```
NoPositionReturned
```

Position(commit_position: Int, prepare_position: Int)

ProtobufDecodeError

pub type ProtobufDecodeError {
  DecodeError(
    expected: String,
    found: String,
    path: List(String),
  )
  FieldNotFound(field_number: Int)
}

Constructors

DecodeError(expected: String, found: String, path: List(String))

```
FieldNotFound(field_number: Int)
```

ReadAllFilter

pub type ReadAllFilter {
  NoFilter
  EventTypePrefix(prefixes: List(String), window: FilterWindow)
  EventTypeRegex(regex: String, window: FilterWindow)
  StreamNamePrefix(prefixes: List(String), window: FilterWindow)
  StreamNameRegex(regex: String, window: FilterWindow)
}

Constructors

```
NoFilter
```

EventTypePrefix(prefixes: List(String), window: FilterWindow)

EventTypeRegex(regex: String, window: FilterWindow)

StreamNamePrefix(prefixes: List(String), window: FilterWindow)

StreamNameRegex(regex: String, window: FilterWindow)

ReadAllOptions

pub type ReadAllOptions {
  ReadAllOptions(
    direction: Direction,
    from_position: ReadAllPosition,
    max_count: Int,
    resolve_links: Bool,
    filter: ReadAllFilter,
  )
}

Constructors

ReadAllOptions(
  direction: Direction,
  from_position: ReadAllPosition,
  max_count: Int,
  resolve_links: Bool,
  filter: ReadAllFilter,
)

ReadAllPosition

pub type ReadAllPosition {
  ReadAllFromStart
  ReadAllFromEnd
  ReadAllFromPosition(
    commit_position: Int,
    prepare_position: Int,
  )
}

Constructors

```
ReadAllFromStart
```
```
ReadAllFromEnd
```

ReadAllFromPosition(commit_position: Int, prepare_position: Int)

ReadEvent

pub type ReadEvent {
  Recorded(RecordedEvent)
  Resolved(link: RecordedEvent, event: RecordedEvent)
}

Constructors

```
Recorded(RecordedEvent)
```

Resolved(link: RecordedEvent, event: RecordedEvent)

ReadMessage

pub type ReadMessage {
  ReadEvent(ReadEvent)
  SubscriptionConfirmed(String)
  Checkpoint(Position)
  CaughtUp(SubscriptionCheckpoint)
  FellBehind(SubscriptionCheckpoint)
  FirstStreamPosition(Int)
  LastStreamPosition(Int)
  LastAllStreamPosition(Position)
  ReadIgnored
}

Constructors

```
ReadEvent(ReadEvent)
```
```
SubscriptionConfirmed(String)
```
```
Checkpoint(Position)
```
```
CaughtUp(SubscriptionCheckpoint)
```
```
FellBehind(SubscriptionCheckpoint)
```
```
FirstStreamPosition(Int)
```
```
LastStreamPosition(Int)
```
```
LastAllStreamPosition(Position)
```
```
ReadIgnored
```

ReadRevision

pub type ReadRevision {
  FromStart
  FromEnd
  FromRevision(Int)
}

Constructors

```
FromStart
```
```
FromEnd
```
```
FromRevision(Int)
```

ReadStreamOptions

pub type ReadStreamOptions {
  ReadStreamOptions(
    direction: Direction,
    from_revision: ReadRevision,
    max_count: Int,
    resolve_links: Bool,
  )
}

Constructors

ReadStreamOptions(
  direction: Direction,
  from_revision: ReadRevision,
  max_count: Int,
  resolve_links: Bool,
)

ReadTransport

pub type ReadTransport(stream, transport_error) {
  ReadTransport(
    open: fn(request.Request(BitArray)) -> Result(
      stream,
      transport_error,
    ),
    receive: fn(stream, Int) -> Result(
      #(stream, ReadTransportMessage),
      transport_error,
    ),
    close: fn(stream) -> Nil,
  )
}

Constructors

ReadTransport(
  open: fn(request.Request(BitArray)) -> Result(
    stream,
    transport_error,
  ),
  receive: fn(stream, Int) -> Result(
    #(stream, ReadTransportMessage),
    transport_error,
  ),
  close: fn(stream) -> Nil,
)

ReadTransportMessage

pub type ReadTransportMessage {
  ReadTransportMessage(BitArray)
  ReadTransportFinished
}

Constructors

```
ReadTransportMessage(BitArray)
```
```
ReadTransportFinished
```

RecordedEvent

pub type RecordedEvent {
  RecordedEvent(
    id: String,
    stream: String,
    revision: Int,
    prepare_position: Int,
    commit_position: Int,
    metadata: List(#(String, String)),
    custom_metadata: BitArray,
    data: BitArray,
  )
}

Constructors

RecordedEvent(
  id: String,
  stream: String,
  revision: Int,
  prepare_position: Int,
  commit_position: Int,
  metadata: List(#(String, String)),
  custom_metadata: BitArray,
  data: BitArray,
)

SetStreamMetadataOptions

pub type SetStreamMetadataOptions {
  SetStreamMetadataOptions(expected_revision: ExpectedRevision)
}

Constructors

SetStreamMetadataOptions(expected_revision: ExpectedRevision)

StreamAcl

pub type StreamAcl {
  StreamAcl(
    read_roles: List(String),
    write_roles: List(String),
    delete_roles: List(String),
    meta_read_roles: List(String),
    meta_write_roles: List(String),
  )
}

Constructors

StreamAcl(
  read_roles: List(String),
  write_roles: List(String),
  delete_roles: List(String),
  meta_read_roles: List(String),
  meta_write_roles: List(String),
)

StreamMetadata

pub type StreamMetadata {
  StreamMetadata(
    max_count: option.Option(Int),
    max_age: option.Option(Int),
    truncate_before: option.Option(Int),
    cache_control: option.Option(Int),
    acl: option.Option(StreamAcl),
    custom: List(#(String, json.Json)),
  )
}

Constructors

StreamMetadata(
  max_count: option.Option(Int),
  max_age: option.Option(Int),
  truncate_before: option.Option(Int),
  cache_control: option.Option(Int),
  acl: option.Option(StreamAcl),
  custom: List(#(String, json.Json)),
)

SubscribeToAllOptions

pub type SubscribeToAllOptions {
  SubscribeToAllOptions(
    direction: Direction,
    from_position: ReadAllPosition,
    resolve_links: Bool,
    filter: ReadAllFilter,
  )
}

Constructors

SubscribeToAllOptions(
  direction: Direction,
  from_position: ReadAllPosition,
  resolve_links: Bool,
  filter: ReadAllFilter,
)

SubscribeToStreamOptions

pub type SubscribeToStreamOptions {
  SubscribeToStreamOptions(
    direction: Direction,
    from_revision: ReadRevision,
    resolve_links: Bool,
  )
}

Constructors

SubscribeToStreamOptions(
  direction: Direction,
  from_revision: ReadRevision,
  resolve_links: Bool,
)

Subscription

pub type Subscription(stream, transport_error) {
  Subscription(
    stream: stream,
    transport: ReadTransport(stream, transport_error),
  )
}

Constructors

Subscription(
  stream: stream,
  transport: ReadTransport(stream, transport_error),
)

SubscriptionCheckpoint

pub type SubscriptionCheckpoint {
  NoSubscriptionCheckpoint
  StreamRevisionCheckpoint(Int)
  AllPositionCheckpoint(Position)
}

Constructors

```
NoSubscriptionCheckpoint
```
```
StreamRevisionCheckpoint(Int)
```
```
AllPositionCheckpoint(Position)
```

Tombstone

pub type Tombstone {
  TombstoneSuccess(position: Position)
}

Constructors

```
TombstoneSuccess(position: Position)
```

TombstoneOptions

pub type TombstoneOptions {
  TombstoneOptions(expected_revision: ExpectedRevision)
}

Constructors

TombstoneOptions(expected_revision: ExpectedRevision)

Values

acl_delete_roles

pub fn acl_delete_roles(
  acl: StreamAcl,
  roles: List(String),
) -> StreamAcl

acl_meta_read_roles

pub fn acl_meta_read_roles(
  acl: StreamAcl,
  roles: List(String),
) -> StreamAcl

acl_meta_write_roles

pub fn acl_meta_write_roles(
  acl: StreamAcl,
  roles: List(String),
) -> StreamAcl

acl_read_roles

pub fn acl_read_roles(
  acl: StreamAcl,
  roles: List(String),
) -> StreamAcl

acl_write_roles

pub fn acl_write_roles(
  acl: StreamAcl,
  roles: List(String),
) -> StreamAcl

append_to_stream

pub fn append_to_stream(
  client: Client,
  stream stream: String,
  events events: List(Event),
  options options: AppendOptions,
  using send: fn(request.Request(BitArray)) -> Result(
    response.Response(BitArray),
    send_error,
  ),
) -> Result(Append, OperationError(send_error))

binary_event

pub fn binary_event(
  uuid id: String,
  type_ type_: String,
  data data: BitArray,
) -> Event

close_subscription

pub fn close_subscription(
  subscription: Subscription(stream, transport_error),
) -> Nil

decode_append_to_stream_response

pub fn decode_append_to_stream_response(
  response: response.Response(BitArray),
) -> Result(Append, Error)

decode_delete_stream_response

pub fn decode_delete_stream_response(
  response: response.Response(BitArray),
) -> Result(Delete, Error)

decode_read_stream_message

pub fn decode_read_stream_message(
  message: BitArray,
) -> Result(ReadMessage, Error)

decode_stream_metadata

pub fn decode_stream_metadata(
  data: BitArray,
) -> Result(StreamMetadata, Error)

decode_tombstone_stream_response

pub fn decode_tombstone_stream_response(
  response: response.Response(BitArray),
) -> Result(Tombstone, Error)

default_append_options

pub fn default_append_options() -> AppendOptions

default_delete_options

pub fn default_delete_options() -> DeleteOptions

default_read_all_options

pub fn default_read_all_options() -> ReadAllOptions

default_read_stream_options

pub fn default_read_stream_options() -> ReadStreamOptions

default_set_stream_metadata_options

pub fn default_set_stream_metadata_options() -> SetStreamMetadataOptions

default_subscribe_to_all_options

pub fn default_subscribe_to_all_options() -> SubscribeToAllOptions

default_subscribe_to_stream_options

pub fn default_subscribe_to_stream_options() -> SubscribeToStreamOptions

default_tombstone_options

pub fn default_tombstone_options() -> TombstoneOptions

delete_expected_revision

pub fn delete_expected_revision(
  options: DeleteOptions,
  expected_revision: ExpectedRevision,
) -> DeleteOptions

delete_stream

pub fn delete_stream(
  client: Client,
  stream stream_name: String,
  options options: DeleteOptions,
  using send: fn(request.Request(BitArray)) -> Result(
    response.Response(BitArray),
    send_error,
  ),
) -> Result(Delete, OperationError(send_error))

expected_revision

pub fn expected_revision(
  options: AppendOptions,
  expected_revision: ExpectedRevision,
) -> AppendOptions

from_connection_string

pub fn from_connection_string(
  connection_string: String,
) -> Result(Client, @internal Error)

get_stream_metadata

pub fn get_stream_metadata(
  client: Client,
  stream stream_name: String,
  using transport: ReadTransport(stream, transport_error),
  within timeout: Int,
) -> Result(StreamMetadata, OperationError(transport_error))

json_event

pub fn json_event(
  uuid id: String,
  event_type type_: String,
  data data: json.Json,
) -> Event

metadata

pub fn metadata(event: Event, metadata: BitArray) -> Event

metadata_acl

pub fn metadata_acl(
  metadata: StreamMetadata,
  acl: StreamAcl,
) -> StreamMetadata

metadata_cache_control

pub fn metadata_cache_control(
  metadata: StreamMetadata,
  cache_control: Int,
) -> StreamMetadata

metadata_custom

pub fn metadata_custom(
  metadata: StreamMetadata,
  key: String,
  value: json.Json,
) -> StreamMetadata

metadata_expected_revision

pub fn metadata_expected_revision(
  options: SetStreamMetadataOptions,
  expected_revision: ExpectedRevision,
) -> SetStreamMetadataOptions

metadata_max_age

pub fn metadata_max_age(
  metadata: StreamMetadata,
  max_age: Int,
) -> StreamMetadata

metadata_max_count

pub fn metadata_max_count(
  metadata: StreamMetadata,
  max_count: Int,
) -> StreamMetadata

metadata_truncate_before

pub fn metadata_truncate_before(
  metadata: StreamMetadata,
  truncate_before: Int,
) -> StreamMetadata

new

pub fn new(endpoint: String) -> Client

read_all

pub fn read_all(
  client: Client,
  options options: ReadAllOptions,
  using transport: ReadTransport(stream, transport_error),
  within timeout: Int,
) -> Result(List(ReadEvent), OperationError(transport_error))

read_all_direction

pub fn read_all_direction(
  options: ReadAllOptions,
  direction: Direction,
) -> ReadAllOptions

read_all_filter

pub fn read_all_filter(
  options: ReadAllOptions,
  filter: ReadAllFilter,
) -> ReadAllOptions

read_all_from_position

pub fn read_all_from_position(
  options: ReadAllOptions,
  position: ReadAllPosition,
) -> ReadAllOptions

read_all_max_count

pub fn read_all_max_count(
  options: ReadAllOptions,
  max_count: Int,
) -> ReadAllOptions

read_all_messages

pub fn read_all_messages(
  client: Client,
  options options: ReadAllOptions,
  using transport: ReadTransport(stream, transport_error),
  within timeout: Int,
) -> Result(List(ReadMessage), OperationError(transport_error))

read_all_resolve_links

pub fn read_all_resolve_links(
  options: ReadAllOptions,
  resolve_links: Bool,
) -> ReadAllOptions

read_stream

pub fn read_stream(
  client: Client,
  stream stream_name: String,
  options options: ReadStreamOptions,
  using transport: ReadTransport(stream, transport_error),
  within timeout: Int,
) -> Result(List(ReadEvent), OperationError(transport_error))

read_stream_from_revision

pub fn read_stream_from_revision(
  options: ReadStreamOptions,
  revision: ReadRevision,
) -> ReadStreamOptions

read_stream_max_count

pub fn read_stream_max_count(
  options: ReadStreamOptions,
  max_count: Int,
) -> ReadStreamOptions

read_stream_messages

pub fn read_stream_messages(
  client: Client,
  stream stream: String,
  options options: ReadStreamOptions,
  using transport: ReadTransport(stream, transport_error),
  within timeout: Int,
) -> Result(List(ReadMessage), OperationError(transport_error))

read_stream_read_direction

pub fn read_stream_read_direction(
  options: ReadStreamOptions,
  direction: Direction,
) -> ReadStreamOptions

read_stream_resolve_links

pub fn read_stream_resolve_links(
  options: ReadStreamOptions,
  resolve_links: Bool,
) -> ReadStreamOptions

receive_subscription_event

pub fn receive_subscription_event(
  subscription: Subscription(stream, transport_error),
  within timeout: Int,
) -> Result(
  #(Subscription(stream, transport_error), ReadEvent),
  OperationError(transport_error),
)

receive_subscription_message

pub fn receive_subscription_message(
  subscription: Subscription(stream, transport_error),
  within timeout: Int,
) -> Result(
  #(Subscription(stream, transport_error), ReadMessage),
  OperationError(transport_error),
)

set_stream_metadata

pub fn set_stream_metadata(
  client: Client,
  stream stream_name: String,
  metadata metadata: StreamMetadata,
  uuid id: String,
  options options: SetStreamMetadataOptions,
  using send: fn(request.Request(BitArray)) -> Result(
    response.Response(BitArray),
    send_error,
  ),
) -> Result(Append, OperationError(send_error))

stream_acl

pub fn stream_acl() -> StreamAcl

stream_metadata

pub fn stream_metadata() -> StreamMetadata

subscribe_to_all

pub fn subscribe_to_all(
  client: Client,
  options options: SubscribeToAllOptions,
  using transport: ReadTransport(stream, transport_error),
) -> Result(
  Subscription(stream, transport_error),
  OperationError(transport_error),
)

subscribe_to_all_direction

pub fn subscribe_to_all_direction(
  options: SubscribeToAllOptions,
  direction: Direction,
) -> SubscribeToAllOptions

subscribe_to_all_filter

pub fn subscribe_to_all_filter(
  options: SubscribeToAllOptions,
  filter: ReadAllFilter,
) -> SubscribeToAllOptions

subscribe_to_all_from_position

pub fn subscribe_to_all_from_position(
  options: SubscribeToAllOptions,
  position: ReadAllPosition,
) -> SubscribeToAllOptions

subscribe_to_all_resolve_links

pub fn subscribe_to_all_resolve_links(
  options: SubscribeToAllOptions,
  resolve_links: Bool,
) -> SubscribeToAllOptions

subscribe_to_stream

pub fn subscribe_to_stream(
  client: Client,
  stream stream_name: String,
  options options: SubscribeToStreamOptions,
  using transport: ReadTransport(stream, transport_error),
) -> Result(
  Subscription(stream, transport_error),
  OperationError(transport_error),
)

subscribe_to_stream_from_revision

pub fn subscribe_to_stream_from_revision(
  options: SubscribeToStreamOptions,
  revision: ReadRevision,
) -> SubscribeToStreamOptions

subscribe_to_stream_read_direction

pub fn subscribe_to_stream_read_direction(
  options: SubscribeToStreamOptions,
  direction: Direction,
) -> SubscribeToStreamOptions

subscribe_to_stream_resolve_links

pub fn subscribe_to_stream_resolve_links(
  options: SubscribeToStreamOptions,
  resolve_links: Bool,
) -> SubscribeToStreamOptions

tombstone_expected_revision

pub fn tombstone_expected_revision(
  options: TombstoneOptions,
  expected_revision: ExpectedRevision,
) -> TombstoneOptions

tombstone_stream

pub fn tombstone_stream(
  client: Client,
  stream stream_name: String,
  options options: TombstoneOptions,
  using send: fn(request.Request(BitArray)) -> Result(
    response.Response(BitArray),
    send_error,
  ),
) -> Result(Tombstone, OperationError(send_error))