CDPotion.Domain.Database (cdpotion v0.1.4)

Summary

Types

Database object.

Unique identifier of Database object.

Database error.

Functions

Disables database tracking, prevents database events from being sent to the client.

Enables database tracking, database events will now be delivered to the client.

Parameters:

  • (Required) database_id: description not provided :(
  • (Required) query: description not provided :(

Parameters:

  • (Required) database_id: description not provided :(

Types

@type database() :: %{
  domain: String.t(),
  id: database_id(),
  name: String.t(),
  version: String.t()
}

Database object.

Link to this type

database_id()

@type database_id() :: String.t()

Unique identifier of Database object.

@type error() :: %{code: integer(), message: String.t()}

Database error.

Functions

@spec disable() :: {String.t(), map()}

Disables database tracking, prevents database events from being sent to the client.

@spec enable() :: {String.t(), map()}

Enables database tracking, database events will now be delivered to the client.

Link to this function

execute_sql(database_id, query)

@spec execute_sql(database_id(), String.t()) :: {String.t(), map()}

Parameters:

  • (Required) database_id: description not provided :(
  • (Required) query: description not provided :(
Link to this function

get_database_table_names(database_id)

@spec get_database_table_names(database_id()) :: {String.t(), map()}

Parameters:

  • (Required) database_id: description not provided :(