[RubyOnRails Guides] Active Record Query Interface - 1편

[RubyOnRails Guides] Active Record Query Interface - 1편

💼 서론

• RubyOnRails Guides Active Record Basics 를 참고해 작성한 글입니다.
• Ruby version은 2.6.3을 사용합니다.
• Ruby On Rails version은 5.2.1을 사용합니다.

😮 Active Record?

[RubyOnRails Guides] Active Record Basics

📖 DB Model 조회(SELECT)

• 기본적인 Model.find(options)의 특징은 아래와 같습니다.
  • 제공된 옵션을 동등한 SQL로 변환
  • SQL 쿼리를 시작하고 데이터베이스에서 해당 결과를 검색
  • 모든 결과 행에 대한 적절한 모델의 Ruby Instance화
  • after_find를 실행한 후 after_initialize 콜벡을 실행할 수 있습니다.

📖 DB Model 단건 및 여러건 조회

find

• 기본키(PK) 기반의 id 값으로 조회하는 메서드 입니다.

User.find(1)

SELECT * FROM users WHERE (users.id = 1) LIMIT 1

• 해당 Model을 조회하지 못할 경우 ActiveRecord::RecordNotFound 예외를 발생시킨다.
• 기본키 배열을 제공하면 여러개의 Model을 조회할 수 있습니다.

User.find([1, 10])

SELECT * FROM users WHERE (users.id IN (1, 10))

take

• 순서없이 레코드를 검색합니다.

User.take

SELECT * FROM users LIMIT 1

• 데이터가 없고 예외가 발생하지 않으면 take 메서드는 ni(NULL)l이 반환됩니다.
• 매개변수를 통해 여러개의 결과를 조회할 수 있습니다.

User.take(2)

SELECT * FROM users LIMIT 2

first

• 기본키로 정렬된 첫번째 데이터를 찾습니다.

User.frist

SELECT * FROM users ORDER BY users.id ASC LIMIT 1

• 레코드를 찾을 수 없으면 예외가 아닌 nil(NULL)을 반환합니다.
• 매개변수를 제공해 여러 개의 Model을 반환할 수 있습니다.

User.first(3)

SELECT * FROM clients ORDER BY users.id ASC LIMIT 3

• order 함수를 사용하면 해당 필드로 정렬 후 첫번쨰 값을 반환하게 됩니다.

User.order(:name).first

SELECT * FROM users ORDER BY users.name ASC LIMIT 1

last

• 기본키로 정렬된 마지막 데이터를 찾습니다.

User.last

SELECT * FROM users ORDER BY users.id DESC LIMIT 1

• 레코드를 찾을 수 없으면 예외가 아닌 nil(NULL)을 반환합니다.
• 매개변수를 제공해 여러 개의 Model을 반환할 수 있습니다.

User.last(3)

SELECT * FROM clients ORDER BY users.id DESC LIMIT 3

• order 함수를 사용하면 해당 필드로 정렬 후 마지막 값을 반환하게 됩니다.

User.order(:name).last

SELECT * FROM users ORDER BY users.name DESC LIMIT 1

find_by

• 일부 조건과 일치하는 첫 번째 레코드를 반환합니다.

User.find_by first_name: 'rutgo'
User.where(first_name: 'rutgo').take

SELECT * FROM users WHERE (users.first_name = 'rutgo') LIMIT 1

• 일치하는 레코드가 없을 경우에는 ActiveRecord:RecordNotFound 에러가 발생

all

• 모든 레코드를 가져오는 메소드로 많은 수의 레코드가 있을 경우 전체 컬렉션이 사용 가능한 메모리 양을 초과할 수 있습니다.
• Rails는 배치로 분할하여 처리하도록 하는데 아래에서 살펴볼 find_each 와 :batch_size 입니다.

find_each

• Model이 가진 데이터를 탐색 후에 각 레코드의 객체 데이터 블록 내에 개별적으로 생성합니다.
• 일괄적 탐색 후 record를 block에 생성합니다.

User.find_each do |user|
     NewsMailer.weekly(user).deliver_now
end

• 기본적으로 사이즈는 1000으로 설정되어 있습니다.
• 옵션을 통해 설정할수도 있습니다.
• :batch_size
  • Record 수 조절
• :start
  • 데이터 탐색 시점
• :finish
  • 데이터 탐색 종료 지점
• :error_on_ignore
  • 관계에 order가 있을 경우 오류 발생 여부를 지정하기 위해 애플리케이션을 재구성 합니다.

find_in_batches

• 개별적이 아니라 collection 형태로 Model의 배열로 block에 Batch를 생성합니다.

Invoice.find_in_fatch do |invoices|
    export.add_invoices(invoices)
end

• 옵션은 find_each 와 같습니다.

🕹 조건

where

• SQL WHERE절과 동일하게 사용합니다.

Client.where("orders_count = '2'")

SELECT * FROM clients WHERE clients.orders_count = 2

• 주의해야할 점은 SQL Injection 공격에 취약할 수 있습니다.

• 따라서 아래와 같이 prepared Statement의 parameterized query 를 사용해야 합니다

• 배열도 조건을 줄 수 있습니다. 또한 여러개를 배열 ㅇ니자로 줄 수 있습니다.

Client.where("orders_count = ?", params[:orders])
Client.where("orders_count = ? AND locked = ?", params[:orders], false)

• 또한 key/value hash와 함께 키를 지정할 수도 있습니다.

Client.where("created_at >= :start_date AND created_at <= :end_date", {start_date: params[:start_date], end_date: params[:end_date]})

• 가독성을 높이도록 Hash Condtion를 사용할 수도 있습니다.

Client.where(locked: true)

SELECT * FROM clients WHERE (clients.locked = 1)

Client.where('locked' => true)

• 추가적으로 belons_to 관계일 경우 연관키를 이용해 join도 가능합니다.

Article.where(author: author)
Author.joins(:articles).where(articles: { author: author })

• 범위 조건인 BETWEEN ~ AND 도 가능합니다.

Client.where(created_at: (Time.mow.midnight - 1.day)..Time.now.midnight)

SELECT * FROM clients WHERE (clients.created_at BETWEEN '2008-12-21 00:00:00' AND '2008-12-22 00:00:00')

• 또한 IN 표현식도 사용이 가능합니다.

Client.where(orders_count: [1,3,5])

SELECT * FROM clients WHERE (clients.orders_count IN (1,3,5))

• NOT 표현식도 가능합니다.

Client.where.not(locked: true)

SELECT * FROM clients WHERE (clients.locked != 1)

• OR 표현식도 가능합니다.

Client.where(locked: true).or(Client.where(orders_count: [1,3,5]))

SELECT * FROM clients WHERE (clients.locked = 1 OR clients.orders_count IN (1,3,5))

order

• 정렬을 해주는 order 표현식에 대한 설명입니다.
• default는 오름차순으로 정렬이 됩니다.

Client.order(:created_at) # 오름차순
Client.order(created_at: :desc) # 오름차순 명시
Client.order(created_at: :asc) # 내림차순
Client.order(orders:count: :asc, created_at :desc) #여러 필드도 정렬이 가능합니다.
Client.order("orders_count ASC").order("created_at DESC") # 여러번 호출 되어도 하나의 ORDER BY문으로 묶기게 됩니다.

SELECT * FROM clients ORDER BY orders_count ASC, created_at DESC

🎖 특정 필드만 선택

• find 메소드는 SELECT *과 같이 모든 필드를 선택합니다.
• 특정 필드만 선택하기 위해서는 select 메소드를 사용하면 됩니다.

Client.select("viewable_by, locked")

SELECT viewable_by, locked FROM clients

Client.seelect(:name).distinct # 중복 제거

SELECT DISTINCT name FROM clients

• 고유성 제한 조건을 제거할수도 있습니다.

query = Client.select(:name).distinct

query.distinct(false)

⛔️ Limit & Offset

Clinet.limit(5).offset

SELECT * FROM clients LIMIT 5 OFFSET 30

🎳 Group

Order.select("date(created_at as ordered_date, sum(price) as total_price").group("date(created_at)")

SELECT date(created_at) as ordered_date, sum(price) as total_price
FROM orders
GOUP BY date(created_at)

• 단일 쿼리로 그룹화 된 총 갯수도 조회할 수 있습니다.

Order.group(:status).count

SELECT COUNT (*) AS count_all, status AS status
FROM "orders"
GROUP BY status

Having

• HAVING 절도 사용가능합니다.

Order.select("date(created_at) as ordered_date, sum(price) as total_price").group("date(created)at)").having("sum(price) > ?", 100)

SELECT COUNT (*) AS count_all, status AS status
FROM "orders"
GROUP BY status

🚫 Condition Ignore(조건 무시)

unscope

• 사용하지 않을 메소드를 지정할 수 있습니다. 지금같은 경우에 ORDER BY가 사용하지 않는걸 볼수 있습니다.

Article.where('id > 10').limit(20).order('id asc').unscope(:order)

SELECT * FROM articles WHERE id > 10 LIMIT 20

• 특정 WHERE절의 범위를 해제할 수 있습니다.

Article.where(id: 10, trashed: false).unscope(where: :id)

SELECT "articles".* FROM "articles" WHERE trashed = 0

• unscope를 사용한 관계(relation)는 merge 관계에 있어도 영향을 미치게 됩니다.

Article.order('id asc').merge(Article.unscope(:order))

SELECT "articles".* FROM "articles"

only

• 조건을 재정의할 수 도 있습니다.

Article.where('id > 10').limit(20).order('id desc').only(:order, :where)

SELECT * FROM articles WHERE id > 10 ORDER BY id DESC

#only 없는 query
SELECT * FROM articles WHERE id > 10 ORDER BY id DESC LIMIT 20

reselect

Post.select(:title, :body).reselect(:created_at)

SELECT 'posts'.'created_at' FROM 'posts'

# reselect가 없는 쿼리
SELECT `posts`.`title`, `posts`.`body`, `posts`.`created_at` FROM `posts`

reorder

• 순서를 재정의 합니다.

class Article < ApplicationRecord
  has_many :comments, -> { order('posted_at DESC') }
end

Article.find(10).comments.reorder('name')

SELECT * FROM articles WHERE id = 10 LIMIT 1
SELECT * FROM comments WHERE article_id = 10 ORDER BY name

# reorder를 사용하지 않은 경우
SELECT * FROM articles WHERE id = 10 LIMIT 1
SELECT * FROM comments WHERE article_id = 10 ORDER BY posted_at DESC

reverse_order

• 지정된 순서를 반대로 설정합니다.

Client.where("orders_count > 10").order(:name).reverse_order

SELECT * FROM clients WHERE orders_count > 10 ORDER BY name DESC

• order가 설정되지 않으면 기본키 기준으로 reverse 됩니다.

rewhere

• where 조건을 재정의 합니다.

Article.where(trashed: true).rewhere(trashed: false)

SELECT * FROM articles WHERE `trashed` = 0

• rewhere을 사용하지 않으면 아래와 같이 나오게 됩니다.

Article.where(trashed: true).where(trashed: false)

SELECT * FROM articles WHERE `trashed` = 1 AND 'trashed' = 0

📭 Null

• none 메서드는 레코드가 없는 연결 가능한 관계르ㅏㄹ 반환합니다.
• 반환된 관계에 연결된 모든 후속 조건은 계속 빈 관계를 생성합니다.

Article.none

😮 readOnly

• 읽기 전용 Model로 수정이 허용되지 않는 불변입니다.
• 변경하면 ActiveRecord::ReadOnlyRecord 예외가 발생합니다.

Client.readonly.first
client.visits += 1
client.save # 예외 발생

😇 결론

• Rails는 Active Record로 ORM 기능을 지원합니다.
• Query Interface로 개발자가 Query를 작성하지 않고도 DB SQL을 사용할 수 있습니다.
• 대부분의 Query 명령문을 지원하기 때문에 개발자가 Query에 집중할 필요가 없으며 vender에 맞춰 SQL이 조금씩 다른데 손 쉽게 vender를 변경할 수 있다는 장점도 가지고 있습니다.
• 2편에서는 Lock, Join, Eger Loading 등을 알아보도록 하겠습니다.

출처

Active Record Query Interface - Ruby on Rails Guides