1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe ClickHouse::QueryBuilder, feature_category: :database do
let(:table_name) { :test_table }
let(:builder) { described_class.new(table_name) }
shared_examples "generates correct sql on multiple calls to `to_sql`" do |method_name, argument1, argument2|
it 'returns the same SQL when called multiple times on the same builder' do
query_builder = builder.public_send(method_name, argument1)
first_sql = query_builder.to_sql
second_sql = query_builder.to_sql
expect(first_sql).to eq(second_sql)
end
it 'returns different SQL when called multiple times on different builders' do
query_builder = builder.public_send(method_name, argument1)
query_builder_2 = query_builder.public_send(method_name, argument2)
first_sql = query_builder.to_sql
second_sql = query_builder_2.to_sql
expect(first_sql).not_to eq(second_sql)
end
end
describe "#initialize" do
it 'initializes with correct table' do
expect(builder.table.name).to eq(table_name.to_s)
end
end
describe '#where' do
context 'with simple conditions' do
it 'builds correct where query' do
expected_sql = <<~SQL.lines(chomp: true).join(' ')
SELECT * FROM "test_table"
WHERE "test_table"."column1" = 'value1'
AND "test_table"."column2" = 'value2'
SQL
sql = builder.where(column1: 'value1', column2: 'value2').to_sql
expect(sql).to eq(expected_sql)
end
end
context 'with array conditions' do
it 'builds correct where query' do
expected_sql = <<~SQL.lines(chomp: true).join(' ')
SELECT * FROM "test_table"
WHERE "test_table"."column1" IN (1, 2, 3)
SQL
sql = builder.where(column1: [1, 2, 3]).to_sql
expect(sql).to eq(expected_sql)
end
end
it_behaves_like "generates correct sql on multiple calls to `to_sql`", :where, { column1: 'value1' },
{ column2: 'value2' }
context 'with supported arel nodes' do
it 'builds a query using the In node' do
expected_sql = <<~SQL.lines(chomp: true).join(' ')
SELECT * FROM "test_table"
WHERE "test_table"."column1" IN ('value1', 'value2')
SQL
sql = builder.where(builder.table[:column1].in(%w[value1 value2])).to_sql
expect(sql).to eq(expected_sql)
end
it 'builds a query using the Equality node' do
expected_sql = <<~SQL.lines(chomp: true).join(' ')
SELECT * FROM "test_table"
WHERE "test_table"."column1" = 'value1'
SQL
sql = builder.where(builder.table[:column1].eq('value1')).to_sql
expect(sql).to eq(expected_sql)
end
it 'builds a query using the LessThan node' do
expected_sql = <<~SQL.lines(chomp: true).join(' ')
SELECT * FROM "test_table"
WHERE "test_table"."column1" < 5
SQL
sql = builder.where(builder.table[:column1].lt(5)).to_sql
expect(sql).to eq(expected_sql)
end
it 'builds a query using the LessThanOrEqual node' do
expected_sql = <<~SQL.lines(chomp: true).join(' ')
SELECT * FROM "test_table"
WHERE "test_table"."column1" <= 5
SQL
sql = builder.where(builder.table[:column1].lteq(5)).to_sql
expect(sql).to eq(expected_sql)
end
it 'builds a query using the GreaterThan node' do
expected_sql = <<~SQL.lines(chomp: true).join(' ')
SELECT * FROM "test_table"
WHERE "test_table"."column1" > 5
SQL
sql = builder.where(builder.table[:column1].gt(5)).to_sql
expect(sql).to eq(expected_sql)
end
it 'builds a query using the GreaterThanOrEqual node' do
expected_sql = <<~SQL.lines(chomp: true).join(' ')
SELECT * FROM "test_table"
WHERE "test_table"."column1" >= 5
SQL
sql = builder.where(builder.table[:column1].gteq(5)).to_sql
expect(sql).to eq(expected_sql)
end
end
context 'with unsupported arel nodes' do
it 'raises an error for the unsupported node' do
expect do
builder.where(builder.table[:column1].not_eq('value1')).to_sql
end.to raise_error(ArgumentError, /Unsupported Arel node type for QueryBuilder:/)
end
end
end
describe '#select' do
it 'builds correct select query with single field' do
expected_sql = <<~SQL.chomp
SELECT "test_table"."column1" FROM "test_table"
SQL
sql = builder.select(:column1).to_sql
expect(sql).to eq(expected_sql)
end
it 'builds correct select query with multiple fields' do
expected_sql = <<~SQL.chomp
SELECT "test_table"."column1", "test_table"."column2" FROM "test_table"
SQL
sql = builder.select(:column1, :column2).to_sql
expect(sql).to eq(expected_sql)
end
it 'adds new fields on multiple calls without duplicating' do
expected_sql = <<~SQL.chomp
SELECT "test_table"."column1", "test_table"."column2" FROM "test_table"
SQL
sql = builder.select(:column1).select(:column2).select(:column1).to_sql
expect(sql).to eq(expected_sql)
end
it_behaves_like "generates correct sql on multiple calls to `to_sql`", :select, :column1, :column2
end
describe '#order' do
it 'builds correct order query with direction :desc' do
expected_sql = <<~SQL.lines(chomp: true).join(' ')
SELECT * FROM "test_table"
ORDER BY "test_table"."column1" DESC
SQL
sql = builder.order(:column1, :desc).to_sql
expect(sql).to eq(expected_sql)
end
it 'builds correct order query with default direction asc' do
expected_sql = <<~SQL.lines(chomp: true).join(' ')
SELECT * FROM "test_table"
ORDER BY "test_table"."column1" ASC
SQL
sql = builder.order(:column1).to_sql
expect(sql).to eq(expected_sql)
end
it 'appends orderings on multiple calls' do
expected_sql = <<~SQL.lines(chomp: true).join(' ')
SELECT * FROM "test_table"
ORDER BY "test_table"."column1" DESC,
"test_table"."column2" ASC
SQL
sql = builder.order(:column1, :desc).order(:column2, :asc).to_sql
expect(sql).to eq(expected_sql)
end
it 'appends orderings for the same column when ordered multiple times' do
expected_sql = <<~SQL.lines(chomp: true).join(' ')
SELECT * FROM "test_table"
ORDER BY "test_table"."column1" DESC,
"test_table"."column1" ASC
SQL
sql = builder.order(:column1, :desc).order(:column1, :asc).to_sql
expect(sql).to eq(expected_sql)
end
it 'raises error for invalid direction' do
expect do
builder.order(:column1, :invalid)
end.to raise_error(ArgumentError, "Invalid order direction 'invalid'. Must be :asc or :desc")
end
it_behaves_like "generates correct sql on multiple calls to `to_sql`", :order, :column1, :column2
end
describe '#limit' do
it 'builds correct limit query' do
expected_sql = <<~SQL.lines(chomp: true).join(' ')
SELECT * FROM "test_table"
LIMIT 10
SQL
sql = builder.limit(10).to_sql
expect(sql).to eq(expected_sql)
end
it 'overrides previous limit value when called multiple times' do
expected_sql = <<~SQL.lines(chomp: true).join(' ')
SELECT * FROM "test_table"
LIMIT 20
SQL
sql = builder.limit(10).limit(20).to_sql
expect(sql).to eq(expected_sql)
end
end
describe '#offset' do
it 'builds correct offset query' do
expected_sql = <<~SQL.lines(chomp: true).join(' ')
SELECT * FROM "test_table"
OFFSET 5
SQL
sql = builder.offset(5).to_sql
expect(sql).to eq(expected_sql)
end
it 'overrides previous offset value when called multiple times' do
expected_sql = <<~SQL.lines(chomp: true).join(' ')
SELECT * FROM "test_table"
OFFSET 10
SQL
sql = builder.offset(5).offset(10).to_sql
expect(sql).to eq(expected_sql)
end
end
describe '#group' do
it 'builds correct group query' do
expected_sql = <<~SQL.lines(chomp: true).join(' ')
SELECT * FROM "test_table"
GROUP BY column1
SQL
sql = builder.group(:column1).to_sql
expect(sql).to eq(expected_sql)
end
it 'chains multiple groups when called multiple times' do
expected_sql = <<~SQL.lines(chomp: true).join(' ')
SELECT * FROM "test_table"
GROUP BY column1, column2
SQL
sql = builder.group(:column1).group(:column2).to_sql
expect(sql).to eq(expected_sql)
end
end
describe '#to_sql' do
it 'delegates to the Arel::SelectManager' do
expect(builder.send(:manager)).to receive(:to_sql)
builder.to_sql
end
end
describe '#to_redacted_sql' do
it 'calls ::ClickHouse::Redactor correctly' do
expect(::ClickHouse::Redactor).to receive(:redact).with(builder,
an_instance_of(ClickHouse::Client::BindIndexManager))
builder.to_redacted_sql
end
end
describe '#apply_conditions!' do
it 'applies conditions to the manager' do
manager = builder.send(:manager)
condition = Arel::Nodes::Equality.new(builder.table[:column1], 'value1')
builder.conditions << condition
expect(manager).to receive(:where).with(condition)
builder.send(:apply_conditions!)
end
end
describe 'method chaining', :freeze_time do
it 'builds correct SQL query when methods are chained' do
expected_sql = <<~SQL.lines(chomp: true).join(' ')
SELECT "test_table"."column1", "test_table"."column2"
FROM "test_table"
WHERE "test_table"."column1" = 'value1'
AND "test_table"."column2" = 'value2'
AND "test_table"."created_at" <= '#{Date.today}'
ORDER BY "test_table"."column1" DESC
LIMIT 10
OFFSET 5
SQL
sql = builder
.select(:column1, :column2)
.where(column1: 'value1', column2: 'value2')
.where(builder.table[:created_at].lteq(Date.today))
.order(:column1, 'desc')
.limit(10)
.offset(5)
.to_sql
expect(sql).to eq(expected_sql)
end
end
context 'when combining with a raw query' do
it 'correctly generates the SQL query' do
raw_query = 'SELECT * FROM isues WHERE title = {title:String} AND id IN ({query:Subquery})'
placeholders = {
title: "'test'",
query: builder.select(:id).where(column1: 'value1', column2: 'value2')
}
query = ClickHouse::Client::Query.new(raw_query: raw_query, placeholders: placeholders)
expected_sql = "SELECT * FROM isues WHERE title = {title:String} AND id IN (SELECT \"test_table\".\"id\" " \
"FROM \"test_table\" WHERE \"test_table\".\"column1\" = 'value1' AND " \
"\"test_table\".\"column2\" = 'value2')"
expect(query.to_sql).to eq(expected_sql)
expected_redacted_sql = "SELECT * FROM isues WHERE title = $1 AND id IN (SELECT \"test_table\".\"id\" " \
"FROM \"test_table\" WHERE \"test_table\".\"column1\" = $2 AND " \
"\"test_table\".\"column2\" = $3)"
expect(query.to_redacted_sql).to eq(expected_redacted_sql)
end
end
end
|