Class: ERDB::Db

Inherits:
Object
  • Object
show all
Defined in:
lib/erdb/adapters/db.rb

Direct Known Subclasses

SQL

Instance Method Summary collapse

Constructor Details

#initialize(adapter, database) ⇒ void

Parameters:

  • The adapter to use.

  • The database to connect to.



8
9
10
11
 
# File 'lib/erdb/adapters/db.rb', line 8

def initialize(adapter, database)
  @adapter = adapter
  @database = database
end

Instance Method Details

#connect ⇒ Object

Connect to a database.



16
17
18
 
# File 'lib/erdb/adapters/db.rb', line 16

def connect
  raise "[connect] Not implemented."
end

#disconnect ⇒ Object

Disconnect from a database.



23
24
25
 
# File 'lib/erdb/adapters/db.rb', line 23

def disconnect
  raise "[disconnect] Not implemented."
end

#to_erdb ⇒ Array

Convert database tables to ERD convertable Array.

[
  {
    name: "table_name",
    is_junction_table: false,
    columns: [{ name: "column_name", type: "column_type" }, ...],
    relations: [
      {
        from: {
          table: "table_name",
          column: "column_name"
        },
        to: {
          table: "table_name",
          column: "column_name"
        }
      }
      ...
    ]
  }
  ...
]

Examples:

Example result:

Returns:

  • The converted hash format. see example result below.



56
57
58
 
# File 'lib/erdb/adapters/db.rb', line 56

def to_erdb
  raise "[to_erdb] Not implemented."
end