Trilogy Adapter

https://www.rubydoc.info/gems/activerecord-trilogy-adapter
Admin
Trilogy Adapter is a Ruby on Rails Active Record database adapter for Trilogy, providing...
Tokens:1,709
Snippets:22
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### Instance Method: start

Source: https://www.rubydoc.info/gems/activerecord-trilogy-adapter/Rails/DBConsole

Starts the database console. It checks the RAILS_ENV and configures the adapter. If the adapter is 'trilogy', it uses ActiveRecord::ConnectionAdapters::TrilogyAdapter.dbconsole; otherwise, it falls back to the aliased '_brick_start' method.

```APIDOC
## Instance Method: start

### Description
Starts the database console, handling environment configuration and adapter-specific logic.

### Method
Instance Method

### Endpoint
N/A

### Parameters
None

### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- Object: Returns the result of the database console operation or 'nil' if an error occurs.

#### Response Example
None

### Error Handling
- **NotImplementedError**: Raised if the command-line client is unknown for the specified database.

### Source Code
```ruby
# File 'lib/trilogy_adapter/rails/dbconsole.rb', line 28

def start
  ENV["RAILS_ENV"] ||= @options[:environment] || environment

  if config["adapter"] == "trilogy"
    begin
      ::ActiveRecord::ConnectionAdapters::TrilogyAdapter.dbconsole(config, @options)
    rescue NotImplementedError
      abort "Unknown command-line client for #{db_config.database}."
    end
  else
    _brick_start
  end
end
```
```

--------------------------------

### Start database console

Source: https://www.rubydoc.info/gems/activerecord-trilogy-adapter/Rails/DBConsole

Initializes the database console environment and delegates to the Trilogy adapter if the adapter configuration is set to trilogy.

```ruby
def start
  ENV["RAILS_ENV"] ||= @options[:environment] || environment

  if config["adapter"] == "trilogy"
    begin
      ::ActiveRecord::ConnectionAdapters::TrilogyAdapter.dbconsole(config, @options)
    rescue NotImplementedError
      abort "Unknown command-line client for #{db_config.database}."
    end
  else
    _brick_start
  end
end
```

--------------------------------

### Instance Method: _brick_start

Source: https://www.rubydoc.info/gems/activerecord-trilogy-adapter/Rails/DBConsole

Alias for the 'start' method. This method is part of the internal implementation and is typically not called directly.

```APIDOC
## Instance Method: _brick_start

### Description
Alias for the 'start' method.

### Method
Instance Method

### Endpoint
N/A

### Parameters
None

### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- Object: Returns the result of the 'start' method.

### Response Example
None

### Source Code
```ruby
# File 'lib/trilogy_adapter/rails/dbconsole.rb', line 27

alias _brick_start start
```
```

--------------------------------

### Alias _brick_start method

Source: https://www.rubydoc.info/gems/activerecord-trilogy-adapter/Rails/DBConsole

Creates an alias for the start method to support legacy or alternative console initialization.

```ruby
alias _brick_start start
```

--------------------------------

### Add Gemfile Dependency

Source: https://www.rubydoc.info/gems/activerecord-trilogy-adapter

Add this line to your Gemfile to include the adapter and run bundle install.

```ruby
# Gemfile
gem "activerecord-trilogy-adapter"

```

--------------------------------

### Configure Database Adapter

Source: https://www.rubydoc.info/gems/activerecord-trilogy-adapter

Update your database configuration to specify 'trilogy' as the adapter.

```yaml
# config/database.yml
adapter: trilogy

```

--------------------------------

### Rails::DBConsole Class Documentation

Source: https://www.rubydoc.info/gems/activerecord-trilogy-adapter/Rails/DBConsole

Documentation for the Rails::DBConsole class, including its inheritance, included modules, and instance methods.

```APIDOC
## Class: Rails::DBConsole

### Description
Provides database console functionality for Rails applications using the Trilogy adapter.

### Inheritance
- Object
- Rails::DBConsole

### Includes
- TrilogyAdapter::Rails::DBConsole

### Defined in
- lib/trilogy_adapter/rails/dbconsole.rb
```

--------------------------------

### ActiveRecord Connection Adapters

Source: https://www.rubydoc.info/gems/activerecord-trilogy-adapter/ActiveRecord

Lists and describes the connection adapter classes available within ActiveRecord, including the Trilogy adapter and its configurations.

```APIDOC
## ActiveRecord Connection Adapters

### Classes

- **PoolConfig** (`ActiveRecord::ConnectionSpecification`)
  - Represents connection pool configuration.

- **Trilogy** (`ActiveRecord::ConnectionAdapters::Trilogy`)
  - Handles database statements specific to the Trilogy adapter.
  - **DatabaseStatements** (`ActiveRecord::ConnectionAdapters::Trilogy`)
    - Implements database operations for the Trilogy adapter.

- **TrilogyAdapter** (`ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter`)
  - The main adapter class for connecting to databases using Trilogy.
```

--------------------------------

### ActiveRecord::ConnectionAdapters Module

Source: https://www.rubydoc.info/gems/activerecord-trilogy-adapter/ActiveRecord/ConnectionAdapters

Details about the ActiveRecord::ConnectionAdapters module, including defined files and sub-modules/classes.

```APIDOC
## Module: ActiveRecord::ConnectionAdapters

### Description
This module contains connection adapter implementations for ActiveRecord.

### Defined In
- lib/active_record/connection_adapters/trilogy_adapter.rb
- lib/active_record/connection_adapters/trilogy/database_statements.rb

### Defined Under Namespace
**Modules:** Trilogy
**Classes:** PoolConfig, TrilogyAdapter
```

--------------------------------

### Trilogy Adapter Top Level Namespace

Source: https://www.rubydoc.info/gems/activerecord-trilogy-adapter/ActiveRecord

Details the components directly available under the TrilogyAdapter top-level namespace.

```APIDOC
## TrilogyAdapter Top Level Namespace

### Classes

- **Connection**
  - Represents a database connection using the Trilogy adapter.

- **Rails**
  - Contains Rails-specific integrations for the Trilogy adapter.
  - **DBConsole** (`TrilogyAdapter::Rails`)
    - Provides a database console for Rails applications using the Trilogy adapter.
    - **Adapter** (`SimpleDelegator`)
      - An adapter class used within the DBConsole.
```

--------------------------------

### TrilogyAdapter::Rails Module

Source: https://www.rubydoc.info/gems/activerecord-trilogy-adapter/ActiveRecord/ConnectionAdapters

Details about the Rails integration within the TrilogyAdapter.

```APIDOC
## Module: TrilogyAdapter::Rails

### Description
Provides Rails-specific functionalities for the Trilogy adapter.

### Defined Under Namespace
**Classes:** DBConsole
```

--------------------------------

### ActiveRecord Module Overview

Source: https://www.rubydoc.info/gems/activerecord-trilogy-adapter/ActiveRecord

Details the structure and defined elements within the ActiveRecord module, specifically focusing on its connection adapters.

```APIDOC
## Module: ActiveRecord

### Description
Provides the core functionality for interacting with databases using the ActiveRecord ORM.

### Defined In
- lib/active_record/connection_adapters/trilogy_adapter.rb
- lib/active_record/connection_adapters/trilogy/database_statements.rb

### Defined Under Namespace
**Modules:**
- ConnectionAdapters

**Classes:**
- DatabaseConnectionError
```

--------------------------------

### TrilogyAdapter Class

Source: https://www.rubydoc.info/gems/activerecord-trilogy-adapter/ActiveRecord/ConnectionAdapters

Information about the TrilogyAdapter class and its related components.

```APIDOC
## Class: TrilogyAdapter

### Description
Represents the Trilogy adapter for ActiveRecord connections.

### Defined Under Namespace
**Classes:** Connection, RailsAdapter
```

--------------------------------

### Rails DBConsole

Source: https://www.rubydoc.info/gems/activerecord-trilogy-adapter/ActiveRecord

Details the DBConsole class within the Rails namespace, used for interactive database sessions.

```APIDOC
## Rails DBConsole

### Class: Rails::DBConsole

#### Description
Provides a database console interface for Rails applications when using the Trilogy adapter.

#### Defined Under Namespace
**Classes:**
- Adapter (`SimpleDelegator`)
```

--------------------------------

### TrilogyAdapter Railtie

Source: https://www.rubydoc.info/gems/activerecord-trilogy-adapter/ActiveRecord

Details the Railtie class for the TrilogyAdapter, used for integrating with Rails applications.

```APIDOC
## TrilogyAdapter Railtie

### Class: TrilogyAdapter::Railtie

#### Description
Integrates the Trilogy adapter with Rails applications, providing necessary configurations and initializers.
```
Tokens:
Raw