Tungsten

v0.1.0

Tungsten v0.1.0 Tungsten.CDP.Database View Source

Database

This domain has no documentation

Link to this section Summary

Types

cdp_database_id_type()

Database.DatabaseId

cdp_database_type()

Database.Database

cdp_error_type()

Database.Error

Functions

disable(session, parameters \\ %{}, options \\ [])

Database.disable

enable(session, parameters \\ %{}, options \\ [])

Database.enable

execute_sql(session, parameters, options \\ [])

Database.executeSQL

get_database_table_names(session, parameters, options \\ [])

Database.getDatabaseTableNames

Link to this section Types

Link to this type

cdp_database_id_type() View Source 
cdp_database_id_type() :: String.t()

Database.DatabaseId

Unique identifier of Database object.

Link to this type

cdp_database_type() View Source 
cdp_database_type() :: %{
  id: cdp_database_id_type(),
  domain: String.t(),
  name: String.t(),
  version: String.t()
}

Database.Database

Database object.

Link to this type

cdp_error_type() View Source 
cdp_error_type() :: %{message: String.t(), code: integer()}

Database.Error

Database error.

Link to this section Functions

Link to this function

disable(session, parameters \\ %{}, options \\ []) View Source 
disable(GenServer.server(), map(), Tungsten.Connection.exec_options()) ::
  {:ok, map()} | {:error, term()}

Database.disable

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

Link to this function

enable(session, parameters \\ %{}, options \\ []) View Source 
enable(GenServer.server(), map(), Tungsten.Connection.exec_options()) ::
  {:ok, map()} | {:error, term()}

Database.enable

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

Link to this function

execute_sql(session, parameters, options \\ []) View Source 
execute_sql(
  GenServer.server(),
  %{database_id: cdp_database_id_type(), query: String.t()},
  Tungsten.Connection.exec_options()
) ::
  {:ok,
   %{
     optional(:column_names) => [String.t()],
     optional(:values) => [any()],
     optional(:sql_error) => cdp_error_type()
   }}
  | {:error, term()}

Database.executeSQL

This command has no documentation

Link to this function

get_database_table_names(session, parameters, options \\ []) View Source 
get_database_table_names(
  GenServer.server(),
  %{database_id: cdp_database_id_type()},
  Tungsten.Connection.exec_options()
) :: {:ok, %{table_names: [String.t()]}} | {:error, term()}

Database.getDatabaseTableNames

This command has no documentation