View Source OpenApiTypesense.Operations (OpenApiTypesense v0.4.1)

Provides API endpoints related to operations

Summary

Functions

Get stats about API endpoints.

Either one of

Get current RAM, CPU, Disk & Network usage metrics.

Either one of

Creates a point-in-time snapshot of a Typesense node's state and data in the specified directory.

Triggers a follower node to initiate the raft voting process, which triggers leader re-election.

Either one of

Either one of

Functions

retrieve_api_stats()

@spec retrieve_api_stats() :: {:ok, OpenApiTypesense.APIStatsResponse.t()} | :error

Get stats about API endpoints.

Retrieve the stats about API endpoints.

retrieve_api_stats(opts)

@spec retrieve_api_stats(map() | OpenApiTypesense.Connection.t() | keyword()) ::
  {:ok, OpenApiTypesense.APIStatsResponse.t()} | :error

Either one of:

  • retrieve_api_stats(opts)
  • retrieve_api_stats(%{api_key: xyz, host: ...})
  • retrieve_api_stats(Connection.new())

retrieve_api_stats(conn, opts)

@spec retrieve_api_stats(
  map() | OpenApiTypesense.Connection.t(),
  keyword()
) :: {:ok, OpenApiTypesense.APIStatsResponse.t()} | :error

Either one of:

  • retrieve_api_stats(%{api_key: xyz, host: ...}, opts)
  • retrieve_api_stats(Connection.new(), opts)

retrieve_metrics()

@spec retrieve_metrics() :: {:ok, map()} | :error

Get current RAM, CPU, Disk & Network usage metrics.

Retrieve the metrics.

retrieve_metrics(opts)

@spec retrieve_metrics(map() | OpenApiTypesense.Connection.t() | keyword()) ::
  {:ok, map()} | :error

Either one of:

  • retrieve_metrics(opts)
  • retrieve_metrics(%{api_key: xyz, host: ...})
  • retrieve_metrics(Connection.new())

retrieve_metrics(conn, opts)

@spec retrieve_metrics(
  map() | OpenApiTypesense.Connection.t(),
  keyword()
) :: {:ok, map()} | :error

Either one of:

  • retrieve_metrics(%{api_key: xyz, host: ...}, opts)
  • retrieve_metrics(Connection.new(), opts)

take_snapshot(opts)

@spec take_snapshot(keyword()) :: {:ok, OpenApiTypesense.SuccessStatus.t()} | :error

Creates a point-in-time snapshot of a Typesense node's state and data in the specified directory.

Creates a point-in-time snapshot of a Typesense node's state and data in the specified directory. You can then backup the snapshot directory that gets created and later restore it as a data directory, as needed.

Options

  • snapshot_path: The directory on the server where the snapshot should be saved.

take_snapshot(conn, opts)

@spec take_snapshot(
  map() | OpenApiTypesense.Connection.t(),
  keyword()
) :: {:ok, OpenApiTypesense.SuccessStatus.t()} | :error

Either one of:

  • take_snapshot(%{api_key: xyz, host: ...}, opts)
  • take_snapshot(Connection.new(), opts)

vote()

@spec vote() :: {:ok, OpenApiTypesense.SuccessStatus.t()} | :error

Triggers a follower node to initiate the raft voting process, which triggers leader re-election.

Triggers a follower node to initiate the raft voting process, which triggers leader re-election. The follower node that you run this operation against will become the new leader, once this command succeeds.

vote(opts)

@spec vote(map() | OpenApiTypesense.Connection.t() | keyword()) ::
  {:ok, OpenApiTypesense.SuccessStatus.t()} | :error

Either one of:

  • vote(opts)
  • vote(%{api_key: xyz, host: ...})
  • vote(Connection.new())

vote(conn, opts)

@spec vote(
  map() | OpenApiTypesense.Connection.t(),
  keyword()
) :: {:ok, OpenApiTypesense.SuccessStatus.t()} | :error

Either one of:

  • vote(%{api_key: xyz, host: ...}, opts)
  • vote(Connection.new(), opts)