Class: Webhookdb::DBAdapter

Inherits:
Object
  • Object
show all
Defined in:
lib/webhookdb/db_adapter.rb

Direct Known Subclasses

PG, Snowflake

Defined Under Namespace

Modules: ColumnTypes, DefaultSql Classes: Column, Connection, Index, PG, Schema, SequelConnection, Snowflake, Table, TableDescriptor, UnsupportedAdapter

Constant Summary collapse

VALID_IDENTIFIER = 
/^[a-zA-Z][a-zA-Z\d_ ]*$/
INVALID_IDENTIFIER_MESSAGE = 
"Identifiers must start with a letter and " \
"contain only letters, numbers, spaces, and underscores. " \
"See https://docs.webhookdb.com/concepts/valid-identifiers/ for rules " \
"about identifiers like schema, table, and column names."

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#name ⇒ Symbol

Returns:

  • (Symbol) 



# File 'lib/webhookdb/db_adapter.rb', line 72

#table ⇒ Table

Returns:




# File 'lib/webhookdb/db_adapter.rb', line 72

#targets ⇒ Array<Column>

Returns:




# File 'lib/webhookdb/db_adapter.rb', line 72

#unique ⇒ Boolean

Returns:

  • (Boolean) 



# File 'lib/webhookdb/db_adapter.rb', line 72

Class Method Details

.adapter(url) ⇒ Webhookdb::DBAdapter

Parameters:

  • url (String)

Returns:



191
192
193
194
195
196
197
198
199
200
 
# File 'lib/webhookdb/db_adapter.rb', line 191

def self.adapter(url)
  case url
    when /^postgres/
      return Webhookdb::DBAdapter::PG.new
    when /^snowflake/
      return Webhookdb::DBAdapter::Snowflake.new
    else
      raise UnsupportedAdapter, "no adapter available for #{url}"
  end
end

.supported_adapters_message ⇒ Object 



202
203
204
 
# File 'lib/webhookdb/db_adapter.rb', line 202

def self.supported_adapters_message
  return "Postgres (postgres://), SnowflakeDB (snowflake://)"
end

Instance Method Details

#add_column_sql(table, column, if_not_exists: false) ⇒ String

Parameters:

  • table (Table)
  • column (Column)
  • if_not_exists (Boolean) (defaults to: false)

Returns:

  • (String)

Raises:

  • (NotImplementedError) 


167
168
169
 
# File 'lib/webhookdb/db_adapter.rb', line 167

def add_column_sql(table, column, if_not_exists: false)
  raise NotImplementedError
end

#connection(url) ⇒ Connection

Return a new Connection for the adapter. By default, return a SequelConnection, but adapters not using Sequel will need their own type.

Returns:



137
138
139
 
# File 'lib/webhookdb/db_adapter.rb', line 137

def connection(url)
  return SequelConnection.new(url)
end

#create_index_sql(index, concurrently:) ⇒ String

Parameters:

Returns:

  • (String)

Raises:

  • (NotImplementedError) 


159
160
161
 
# File 'lib/webhookdb/db_adapter.rb', line 159

def create_index_sql(index, concurrently:)
  raise NotImplementedError
end

#create_schema_sql(schema, if_not_exists: false) ⇒ String

Parameters:

  • schema (Schema)
  • if_not_exists (Boolean) (defaults to: false)

Returns:

  • (String)

Raises:

  • (NotImplementedError) 


144
145
146
 
# File 'lib/webhookdb/db_adapter.rb', line 144

def create_schema_sql(schema, if_not_exists: false)
  raise NotImplementedError
end

#create_table_sql(table, columns, schema: nil, if_not_exists: false) ⇒ String

Parameters:

  • table (Table)
  • columns (Array<Column>)
  • schema (Schema) (defaults to: nil)
  • if_not_exists (Boolean) (defaults to: false)

Returns:

  • (String)

Raises:

  • (NotImplementedError) 


153
154
155
 
# File 'lib/webhookdb/db_adapter.rb', line 153

def create_table_sql(table, columns, schema: nil, if_not_exists: false)
  raise NotImplementedError
end

#merge_from_csv(connection, file, table, pk_col, copy_columns) ⇒ Object

Given a table and a (temporary) file with CSV data, import it into the table. Usually this is a COPY INTO command. For PG it would read from stdin, for Snowflake it would have to stage the file.

Parameters:

  • connection (Connection)
  • file (File)
  • table (Table)
  • pk_col (Column) —

    Use this to identifier the same row between source and destination.

  • copy_columns (Array<Column>) —

    All columns to copy. NOTE: This includes the pk column, since it should be copied, as we depend on it persisting.

Raises:

  • (NotImplementedError) 


181
182
183
 
# File 'lib/webhookdb/db_adapter.rb', line 181

def merge_from_csv(connection, file, table, pk_col, copy_columns)
  raise NotImplementedError
end

#verify_connection(url, timeout: 2, statement: "SELECT 1") ⇒ Object 



185
186
187
 
# File 'lib/webhookdb/db_adapter.rb', line 185

def verify_connection(url, timeout: 2, statement: "SELECT 1")
  return self._verify_connection(url, timeout:, statement:)
end