Class: Tina4::Database
- Inherits:
-
Object
- Object
- Tina4::Database
- Defined in:
- lib/tina4/database.rb
Constant Summary collapse
- DRIVERS =
{ "sqlite" => "Tina4::Drivers::SqliteDriver", "sqlite3" => "Tina4::Drivers::SqliteDriver", "postgres" => "Tina4::Drivers::PostgresDriver", "postgresql" => "Tina4::Drivers::PostgresDriver", "mysql" => "Tina4::Drivers::MysqlDriver", "mssql" => "Tina4::Drivers::MssqlDriver", "sqlserver" => "Tina4::Drivers::MssqlDriver", "firebird" => "Tina4::Drivers::FirebirdDriver", "mongodb" => "Tina4::Drivers::MongodbDriver", "mongo" => "Tina4::Drivers::MongodbDriver", "odbc" => "Tina4::Drivers::OdbcDriver" }.freeze
Instance Attribute Summary collapse
-
#connected ⇒ Object
readonly
Returns the value of attribute connected.
-
#driver ⇒ Object
readonly
Returns the value of attribute driver.
-
#driver_name ⇒ Object
readonly
Returns the value of attribute driver_name.
-
#pool ⇒ Object
readonly
Returns the value of attribute pool.
Class Method Summary collapse
-
.create(url, username: "", password: "", pool: nil) ⇒ Object
Static factory — cross-framework consistency: Database.create(url).
-
.from_env(env_key: "TINA4_DATABASE_URL", pool: nil) ⇒ Object
Construct a Database from environment variables.
-
.get_connection(url_or_env_key = "TINA4_DATABASE_URL", username: nil, password: nil, pool: nil) ⇒ Object
Open a database connection — convention name matching SQLAlchemy engine.connect() and the cross-framework Database.get_connection() surface shipped in 3.13.x.
-
.register_instance(db) ⇒ Object
Register a live connection in the class-level WeakRef registry.
-
.reset_request_caches ⇒ Object
Clear the request-scoped query cache on every live Database instance.
-
.strip_trailing_semicolons(sql) ⇒ Object
v3.13.12 — strip trailing ‘;` from user SQL before the framework wraps it with COUNT(*) subqueries or appends LIMIT/OFFSET.
Instance Method Summary collapse
-
#active_count ⇒ Object
Number of connections currently created (lazy pool connections counted).
- #cache_clear ⇒ Object
-
#cache_new_request ⇒ Object
Clear the request-scoped query cache at the start of an HTTP request.
-
#cache_stats ⇒ Object
── Query Cache ──────────────────────────────────────────────.
-
#checkin(_driver) ⇒ Object
Return a driver to the pool.
-
#checkout ⇒ Object
Check out a driver from the pool (or return the single driver).
- #close ⇒ Object
-
#close_all ⇒ Object
Close all pooled connections (or the single connection).
- #columns(table_name) ⇒ Object (also: #get_columns)
-
#commit ⇒ Object
Commit the current transaction and release the driver pin.
- #connect ⇒ Object
-
#current_driver ⇒ Object
Get the current driver — from pool (round-robin) or single connection.
- #delete(table, filter = {}, params = nil) ⇒ Object
-
#execute(sql, params = []) ⇒ Object
Execute a write statement.
- #execute_many(sql, params_list = []) ⇒ Object
-
#fetch(sql, params = [], limit: 100, offset: nil, no_cache: false) ⇒ Object
Fetch rows with pagination, returning a DatabaseResult.
-
#fetch_all(sql, params = [], limit: nil, offset: nil, no_cache: false) ⇒ Object
Fetch rows and return the records array directly.
-
#fetch_one(sql, params = [], no_cache: false) ⇒ Object
Fetch a single row (or nil).
-
#get_adapter ⇒ Integer
Pre-generate the next available primary key ID using engine-aware strategies.
-
#get_database_type ⇒ Object
Return the normalised engine name for this connection.
-
#get_error ⇒ Object
Return the last execute() error message, or nil.
-
#get_last_id ⇒ Object
Return the last insert ID from execute() or insert().
- #get_next_id(table, pk_column: "id", generator_name: nil) ⇒ Object
-
#initialize(connection_string = nil, username: nil, password: nil, driver_name: nil, pool: nil) ⇒ Database
constructor
A new instance of Database.
- #insert(table, data) ⇒ Object
-
#pool_size ⇒ Object
Returns the configured pool size, or 1 for single-connection mode.
-
#rollback ⇒ Object
Roll back the current transaction and release the driver pin.
-
#start_transaction ⇒ Object
Begin a transaction without a block — matches PHP/Python/Node API.
- #table_exists?(table_name) ⇒ Boolean (also: #table_exists)
- #tables ⇒ Object (also: #get_tables)
- #transaction ⇒ Object
- #update(table, data, filter = {}, params = nil) ⇒ Object
Constructor Details
#initialize(connection_string = nil, username: nil, password: nil, driver_name: nil, pool: nil) ⇒ Database
Returns a new instance of Database.
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 |
# File 'lib/tina4/database.rb', line 180 def initialize(connection_string = nil, username: nil, password: nil, driver_name: nil, pool: nil) @connection_string = connection_string || ENV["TINA4_DATABASE_URL"] @username = username || ENV["TINA4_DATABASE_USERNAME"] @password = password || ENV["TINA4_DATABASE_PASSWORD"] @driver_name = driver_name || detect_driver(@connection_string) # TINA4_DB_POOL falls back when caller doesn't pass `pool:` explicitly. # Default 0 = single connection, N>0 = N pooled connections (round-robin). @pool_size = if pool.nil? (ENV["TINA4_DB_POOL"] || "0").to_i else pool end @connected = false # Per-instance thread-local key for the transaction adapter pin. # Without this pin, every Database method call rotates to a different # pooled connection. Inside a transaction this silently breaks atomicity: # start_transaction begins on adapter A, executes autocommit on B/C, and # commit/rollback land on D — a no-op. start_transaction sets the pin, # commit/rollback clear it. While pinned, current_driver returns the same # driver for every call so the whole transaction runs on one connection. @tx_pin_key = :"tina4_pinned_adapter_#{object_id}" # Per-thread nested-transaction depth counter (DB-contract C, v3.13.37). # A second start_transaction on a thread that already holds the pin is a # double-begin: most engines silently commit or no-op the inner BEGIN, # leaving the connection mid-transaction. We warn + increment depth instead # of re-beginning; the inner commit just decrements; the outer commit/any # rollback releases the pin. @tx_depth_key = :"tina4_tx_depth_#{object_id}" # Query cache. One store, two layers (parity with Python connection.py). # BOTH layers are OPT-IN — the DEFAULT is OFF. # # A request-scoped cache that defaults ON is a footgun: a SELECT MAX(id) # (or generator read) right before an INSERT in the SAME request returns a # cached pre-write value → duplicate primary keys, and any read-after-write # in one request shows stale state. So both layers default OFF: # • request-scoped (opt-in, TINA4_AUTO_CACHING=true) — dedupes identical # SELECTs to protect the DB from rapid repeat reads on read-heavy # endpoints. Cleared at the START of every HTTP request (so it never # serves rows across requests) AND on any write, with a short safety # TTL (5s) for non-request contexts (scripts/workers). # • persistent (opt-in, TINA4_DB_CACHE=true) — cross-request TTL cache # that is NOT cleared per request; entries expire by TINA4_DB_CACHE_TTL. @cache_persistent = truthy?(ENV["TINA4_DB_CACHE"]) # Default OFF; honour the same truthy semantics the framework uses # (mirrors Python's is_truthy(get("TINA4_AUTO_CACHING", "false"))). @cache_request_scoped = truthy?(ENV["TINA4_AUTO_CACHING"] || "false") @cache_enabled = @cache_persistent || @cache_request_scoped @cache_ttl = if @cache_persistent (ENV["TINA4_DB_CACHE_TTL"] || "30").to_i else (ENV["TINA4_AUTO_CACHING_TTL"] || "5").to_i end @query_cache = {} # key => { expires_at:, value: } @cache_hits = 0 @cache_misses = 0 @cache_mutex = Mutex.new # Persistent mode may route through the unified CacheBackend (redis/ # valkey/memcached/mongodb/database via TINA4_DB_CACHE_BACKEND) so # multiple instances can share one cache with global write-invalidation. # Request-scoped mode always stays in-process (the @query_cache dict). # The DatabaseResult is serialized to a JSON-friendly Hash before storing # and reconstructed on read so shared backends work cross-instance. @cache_backend = nil if @cache_persistent begin @cache_backend = Tina4::CacheBackends.create_backend( backend: ENV["TINA4_DB_CACHE_BACKEND"] || "memory", url: ENV["TINA4_DB_CACHE_URL"], max_entries: 1000 ) rescue StandardError @cache_backend = nil # fall back to the in-process dict end end # Register this connection so Tina4::Database.reset_request_caches can # clear its request-scoped entries at the start of every HTTP request. Tina4::Database.register_instance(self) if @pool_size > 0 # Pooled mode — create a ConnectionPool with lazy driver creation @pool = ConnectionPool.new( @pool_size, driver_factory: method(:create_driver), connection_string: @connection_string, username: @username, password: @password ) @driver = nil @connected = true else # Single-connection mode — current behavior @pool = nil @driver = create_driver connect end end |
Instance Attribute Details
#connected ⇒ Object (readonly)
Returns the value of attribute connected.
70 71 72 |
# File 'lib/tina4/database.rb', line 70 def connected @connected end |
#driver ⇒ Object (readonly)
Returns the value of attribute driver.
70 71 72 |
# File 'lib/tina4/database.rb', line 70 def driver @driver end |
#driver_name ⇒ Object (readonly)
Returns the value of attribute driver_name.
70 71 72 |
# File 'lib/tina4/database.rb', line 70 def driver_name @driver_name end |
#pool ⇒ Object (readonly)
Returns the value of attribute pool.
70 71 72 |
# File 'lib/tina4/database.rb', line 70 def pool @pool end |
Class Method Details
.create(url, username: "", password: "", pool: nil) ⇒ Object
Static factory — cross-framework consistency: Database.create(url)
139 140 141 142 143 |
# File 'lib/tina4/database.rb', line 139 def self.create(url, username: "", password: "", pool: nil) new(url, username: username.empty? ? nil : username, password: password.empty? ? nil : password, pool: pool) end |
.from_env(env_key: "TINA4_DATABASE_URL", pool: nil) ⇒ Object
Construct a Database from environment variables. Returns nil if the named env var is not set.
147 148 149 150 151 152 153 154 155 |
# File 'lib/tina4/database.rb', line 147 def self.from_env(env_key: "TINA4_DATABASE_URL", pool: nil) url = ENV[env_key] return nil if url.nil? || url.strip.empty? new(url, username: ENV["TINA4_DATABASE_USERNAME"], password: ENV["TINA4_DATABASE_PASSWORD"], pool: pool) end |
.get_connection(url_or_env_key = "TINA4_DATABASE_URL", username: nil, password: nil, pool: nil) ⇒ Object
Open a database connection — convention name matching SQLAlchemy engine.connect() and the cross-framework Database.get_connection() surface shipped in 3.13.x.
The first argument may be either a URL (containing ‘://` or `sqlite:`) or an env-var name. Falls back to in-memory SQLite when no URL resolves — matches Python tina4_python’s default behaviour.
db = Tina4::Database.get_connection # from TINA4_DATABASE_URL
db = Tina4::Database.get_connection("sqlite::memory:") # explicit URL
db = Tina4::Database.get_connection("postgres://...", username: "u", password: "p")
168 169 170 171 172 173 174 175 176 177 178 |
# File 'lib/tina4/database.rb', line 168 def self.get_connection(url_or_env_key = "TINA4_DATABASE_URL", username: nil, password: nil, pool: nil) if url_or_env_key.include?("://") || url_or_env_key.start_with?("sqlite:") return new(url_or_env_key, username: username, password: password, pool: pool) end db = from_env(env_key: url_or_env_key, pool: pool) return db if db # Fallback: in-memory SQLite — matches Python parity. new("sqlite::memory:", username: username, password: password, pool: pool) end |
.register_instance(db) ⇒ Object
Register a live connection in the class-level WeakRef registry.
82 83 84 85 86 |
# File 'lib/tina4/database.rb', line 82 def register_instance(db) @instances_mutex.synchronize do @instances << WeakRef.new(db) end end |
.reset_request_caches ⇒ Object
Clear the request-scoped query cache on every live Database instance.
The request dispatcher calls this at the start of each HTTP request so request-scoped caching never serves rows across requests (zero cross-request staleness). Persistent-mode connections are left alone. Dead WeakRefs (closed/GC’d connections) are pruned as we go.
94 95 96 97 98 99 100 101 102 103 104 105 106 |
# File 'lib/tina4/database.rb', line 94 def reset_request_caches @instances_mutex.synchronize do @instances.reject! do |ref| begin inst = ref.__getobj__ inst.cache_new_request false rescue WeakRef::RefError, StandardError true # dead reference (or errored) — prune it end end end end |
.strip_trailing_semicolons(sql) ⇒ Object
v3.13.12 — strip trailing ‘;` from user SQL before the framework wraps it with COUNT(*) subqueries or appends LIMIT/OFFSET. Without this, ““SELECT * FROM t;”“ produces ““SELECT * FROM t; LIMIT 100 OFFSET 0”“ — a syntax error on every engine. Internal semicolons (inside string literals, between meaningful statements) are left alone; drivers reject those if multi-statement isn’t supported.
129 130 131 132 133 134 135 136 |
# File 'lib/tina4/database.rb', line 129 def self.strip_trailing_semicolons(sql) return sql if sql.nil? || sql.empty? stripped = sql.rstrip while stripped.end_with?(";") stripped = stripped[0..-2].rstrip end stripped end |
Instance Method Details
#active_count ⇒ Object
Number of connections currently created (lazy pool connections counted).
758 759 760 761 762 763 764 |
# File 'lib/tina4/database.rb', line 758 def active_count if @pool @pool.active_count else @connected ? 1 : 0 end end |
#cache_clear ⇒ Object
350 351 352 353 354 355 356 357 |
# File 'lib/tina4/database.rb', line 350 def cache_clear @cache_backend.clear if @cache_backend @cache_mutex.synchronize do @query_cache.clear @cache_hits = 0 @cache_misses = 0 end end |
#cache_new_request ⇒ Object
Clear the request-scoped query cache at the start of an HTTP request.
No-op in persistent mode (TINA4_DB_CACHE=true) so cross-request entries survive up to their TTL. Cumulative hit/miss counters are preserved.
363 364 365 366 367 |
# File 'lib/tina4/database.rb', line 363 def cache_new_request return unless @cache_request_scoped && !@cache_persistent @cache_mutex.synchronize { @query_cache.clear } end |
#cache_stats ⇒ Object
── Query Cache ──────────────────────────────────────────────
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 |
# File 'lib/tina4/database.rb', line 323 def cache_stats if @cache_backend bs = @cache_backend.stats return { enabled: @cache_enabled, mode: cache_mode, hits: @cache_hits, misses: @cache_misses, size: bs[:size], backend: bs[:backend] || @cache_backend.name, ttl: @cache_ttl } end @cache_mutex.synchronize do { enabled: @cache_enabled, mode: cache_mode, hits: @cache_hits, misses: @cache_misses, size: @query_cache.size, backend: "memory", ttl: @cache_ttl } end end |
#checkin(_driver) ⇒ Object
Return a driver to the pool. No-op for round-robin pool or single connection.
772 773 774 |
# File 'lib/tina4/database.rb', line 772 def checkin(_driver) # no-op end |
#checkout ⇒ Object
Check out a driver from the pool (or return the single driver).
767 768 769 |
# File 'lib/tina4/database.rb', line 767 def checkout current_driver end |
#close ⇒ Object
296 297 298 299 300 301 302 303 |
# File 'lib/tina4/database.rb', line 296 def close if @pool @pool.close_all elsif @driver && @connected @driver.close end @connected = false end |
#close_all ⇒ Object
Close all pooled connections (or the single connection).
777 778 779 |
# File 'lib/tina4/database.rb', line 777 def close_all close end |
#columns(table_name) ⇒ Object Also known as: get_columns
712 713 714 |
# File 'lib/tina4/database.rb', line 712 def columns(table_name) current_driver.columns(table_name) end |
#commit ⇒ Object
Commit the current transaction and release the driver pin.
FAILS LOUD (v3.13.37, DB-contract C): if the underlying commit raises, capture @last_error and RE-RAISE — never swallow. On failure the transaction pin is RETAINED so the caller’s follow-up #rollback lands on the SAME connection (clearing it would leak a dirty connection back into the pool and route the rollback to a different one). The pin is cleared ONLY on a successful commit. An inner commit of an ignored nested begin (depth > 1) just decrements the depth and returns — the outer commit is the real one.
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 |
# File 'lib/tina4/database.rb', line 670 def commit depth = (Thread.current[@tx_depth_key] || 0) if depth > 1 Thread.current[@tx_depth_key] = depth - 1 return end current_driver.commit @last_error = nil # Success — release the pin. Thread.current[@tx_pin_key] = nil Thread.current[@tx_depth_key] = nil rescue => e # Keep the pin so rollback reaches this same connection. @last_error = e. raise end |
#connect ⇒ Object
281 282 283 284 285 286 287 288 289 290 291 292 293 294 |
# File 'lib/tina4/database.rb', line 281 def connect @driver.connect(@connection_string, username: @username, password: @password) @connected = true # Enable autocommit if TINA4_AUTOCOMMIT env var is set if truthy?(ENV["TINA4_AUTOCOMMIT"]) && @driver.respond_to?(:autocommit=) @driver.autocommit = true end Tina4::Log.info("Database connected: #{@driver_name}") rescue => e Tina4::Log.error("Database connection failed: #{e.}") @connected = false end |
#current_driver ⇒ Object
Get the current driver — from pool (round-robin) or single connection.
Inside a transaction, all calls must land on the SAME driver — otherwise start_transaction, execute, and commit each rotate to a different pooled connection and the transaction is meaningless. start_transaction pins the driver to the calling thread; commit/rollback release it.
311 312 313 314 315 316 317 318 319 |
# File 'lib/tina4/database.rb', line 311 def current_driver pinned = Thread.current[@tx_pin_key] return pinned if pinned if @pool @pool.checkout else @driver end end |
#delete(table, filter = {}, params = nil) ⇒ Object
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 |
# File 'lib/tina4/database.rb', line 516 def delete(table, filter = {}, params = nil) cache_invalidate if @cache_enabled drv = current_driver # List of hashes — delete each row if filter.is_a?(Array) filter.each { |row| delete(table, row) } return { success: true } end # String filter — raw WHERE clause with optional params if filter.is_a?(String) sql = "DELETE FROM #{table}" sql += " WHERE #{filter}" unless filter.empty? drv.execute(sql, Array(params)) return { success: true } end # Hash filter — build WHERE from keys where_parts = filter.keys.map { |k| "#{k} = #{drv.placeholder}" } sql = "DELETE FROM #{table}" sql += " WHERE #{where_parts.join(' AND ')}" unless filter.empty? drv.execute(sql, filter.values) { success: true } end |
#execute(sql, params = []) ⇒ Object
Execute a write statement. FAILS LOUD — raises on a SQL error.
On a SQL error (bad SQL, constraint violation, dead/aborted connection, missing driver) the cause is captured on @last_error / #get_error AND the error is re-raised — execute() never silently returns false on failure. Almost no caller checks a boolean after every write, so the old swallow-and-return-false behaviour turned a failed INSERT/UPDATE/DELETE into a silent partial-write footgun. This mirrors fetch()/fetch_one(), which already raise, and the Python master (database.execute).
On SUCCESS the return is unchanged: a DatabaseResult when the SQL contains RETURNING, CALL, EXEC, or SELECT (truthy), otherwise true. Never false.
Higher-level callers that promise a boolean (ORM save/create_table) wrap this in begin/rescue and return false themselves; the migration runner and dev-admin/MCP DB tools catch the raise and surface it as a failed migration or a clean { error: } payload respectively.
583 584 585 586 587 588 589 590 591 592 593 594 595 596 |
# File 'lib/tina4/database.rb', line 583 def execute(sql, params = []) cache_invalidate if @cache_enabled result = current_driver.execute(sql, params) @last_error = nil sql_upper = sql.strip.upcase if sql_upper.include?("RETURNING") || sql_upper.start_with?("CALL ") || sql_upper.start_with?("EXEC ") || sql_upper.start_with?("SELECT ") return result end true rescue => e @last_error = e. raise end |
#execute_many(sql, params_list = []) ⇒ Object
598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 |
# File 'lib/tina4/database.rb', line 598 def execute_many(sql, params_list = []) results = [] drv = current_driver drv.begin_transaction begin params_list.each do |params| results << drv.execute(sql, params) end drv.commit rescue => e drv.rollback raise e end results end |
#fetch(sql, params = [], limit: 100, offset: nil, no_cache: false) ⇒ Object
Fetch rows with pagination, returning a DatabaseResult.
FAILS LOUD (v3.13.37, DB-contract A): a SQL error in the main query propagates — a typo’d / bad SELECT RAISES, it never silently returns an empty result. The cause is captured on @last_error / #get_error before the re-raise (parity with #execute and the Python master), so the public API can read why it failed even for engines whose driver doesn’t expose its own last_error. Because the raise happens BEFORE cache_set is reached, a buried failure is never written into the query cache.
Pass ‘no_cache: true` to bypass the query cache entirely for this single call — no lookup, no store — and run the query directly against the driver. Works for both the request-scoped auto-cache and the persistent DB cache. The default `false` preserves the cached behaviour. Parity with Python db.fetch(no_cache=) / PHP / Node.
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 |
# File 'lib/tina4/database.rb', line 403 def fetch(sql, params = [], limit: 100, offset: nil, no_cache: false) offset ||= 0 drv = current_driver # v3.13.12: strip trailing `;` so the driver's apply_limit # (which appends "LIMIT N OFFSET M") doesn't produce # "SELECT * FROM t; LIMIT 100 OFFSET 0" — a syntax error # on every engine. Also helps any COUNT(*) FROM (sql) # subqueries downstream survive a user-supplied semicolon. sql = Tina4::Database.strip_trailing_semicolons(sql) effective_sql = sql # Skip appending LIMIT if SQL already has one has_limit = sql.upcase.split("--")[0].include?("LIMIT") if limit && !has_limit effective_sql = drv.apply_limit(effective_sql, limit, offset) end if @cache_enabled && !no_cache key = cache_key(effective_sql, params) cached = cache_get(key) if cached @cache_mutex.synchronize { @cache_hits += 1 } return cached end # fetch_direct RAISES on a SQL error (and captures @last_error), so a # failed read never reaches cache_set below — we never cache an empty # result produced by a buried failure. result = fetch_direct(drv, effective_sql, params) cache_set(key, result) @cache_mutex.synchronize { @cache_misses += 1 } return result end fetch_direct(drv, effective_sql, params) end |
#fetch_all(sql, params = [], limit: nil, offset: nil, no_cache: false) ⇒ Object
Fetch rows and return the records array directly.
Symmetric with fetch_one. Cross-framework parity with Python db.fetch_all() / PHP $db->fetchAll() / Node db.fetchAll().
rows = db.fetch_all("SELECT * FROM users WHERE active = ?", [1])
rows.each { |row| puts row["name"] }
Returns [] (not nil) when no rows match.
v3.13.12: default ‘limit` is nil (no truncation) — the method name says fetch_all, so it returns all matching rows. Pre-v3.13.12 silently truncated to 100. Pass an explicit `limit:` to cap.
Pass ‘no_cache: true` to bypass the query cache for this call (see #fetch).
384 385 386 |
# File 'lib/tina4/database.rb', line 384 def fetch_all(sql, params = [], limit: nil, offset: nil, no_cache: false) fetch(sql, params, limit: limit, offset: offset, no_cache: no_cache).records end |
#fetch_one(sql, params = [], no_cache: false) ⇒ Object
Fetch a single row (or nil).
FAILS LOUD (v3.13.37, DB-contract A): a SQL error RAISES and populates fetch_one ran the query through #fetch but did not separately guarantee the error capture, and a buried failure could be cached as nil. It now routes the uncached path through fetch_one_direct (capture + re-raise) and, on the cached path, only ever stores a value produced by a SUCCESSFUL read.
Pass ‘no_cache: true` to bypass the query cache entirely for this call —no lookup, no store — running the query directly. The `no_cache` flag is propagated to the inner read so the request-scoped/persistent cache is never populated either. Default `false` preserves cached behaviour.
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 |
# File 'lib/tina4/database.rb', line 453 def fetch_one(sql, params = [], no_cache: false) sql = Tina4::Database.strip_trailing_semicolons(sql) if @cache_enabled && !no_cache key = cache_key(sql + ":ONE", params) cached = cache_get(key) if cached @cache_mutex.synchronize { @cache_hits += 1 } return cached end # Raises (and captures @last_error) BEFORE cache_set, so a failed read # is never cached as nil. value = fetch_one_direct(sql, params) cache_set(key, value) @cache_mutex.synchronize { @cache_misses += 1 } return value end fetch_one_direct(sql, params) end |
#get_adapter ⇒ Integer
Pre-generate the next available primary key ID using engine-aware strategies.
Race-safe implementation using a ‘tina4_sequences` table for SQLite/MySQL/MSSQL fallback. Each call atomically increments the stored counter, so concurrent callers never receive the same value.
-
Firebird: auto-creates a generator if missing, then increments via GEN_ID.
-
PostgreSQL: tries nextval() on the named sequence, auto-creates it if missing.
-
SQLite/MySQL/MSSQL: atomic UPDATE on ‘tina4_sequences` table.
-
Returns 1 if the table is empty or does not exist.
Returns the underlying driver object (pool’s current driver or single driver).
748 749 750 |
# File 'lib/tina4/database.rb', line 748 def get_adapter current_driver end |
#get_database_type ⇒ Object
Return the normalised engine name for this connection.
Cross-framework parity with Python/PHP/Node “get_database_type()“. ORM.create_table needs this to emit engine-correct DDL (SERIAL vs AUTOINCREMENT, BOOLEAN vs INTEGER, TIMESTAMP vs DATETIME). Returns the resolved driver key (“postgres”, “mysql”, “mssql”, “firebird”, “sqlite”, …) — the same alias-normalised value used to pick the driver class, so callers don’t have to re-parse the connection string.
562 563 564 |
# File 'lib/tina4/database.rb', line 562 def get_database_type @driver_name end |
#get_error ⇒ Object
Return the last execute() error message, or nil.
543 544 545 |
# File 'lib/tina4/database.rb', line 543 def get_error @last_error end |
#get_last_id ⇒ Object
Return the last insert ID from execute() or insert().
548 549 550 551 552 |
# File 'lib/tina4/database.rb', line 548 def get_last_id current_driver.last_insert_id rescue nil end |
#get_next_id(table, pk_column: "id", generator_name: nil) ⇒ Object
781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 |
# File 'lib/tina4/database.rb', line 781 def get_next_id(table, pk_column: "id", generator_name: nil) drv = current_driver # Firebird — use generators if @driver_name == "firebird" gen_name = generator_name || "GEN_#{table.upcase}_ID" # Auto-create the generator if it does not exist begin drv.execute("CREATE GENERATOR #{gen_name}") rescue # Generator already exists — ignore end rows = drv.execute_query("SELECT GEN_ID(#{gen_name}, 1) AS NEXT_ID FROM RDB$DATABASE") row = rows.is_a?(Array) ? rows.first : nil val = row_value(row, :NEXT_ID) || row_value(row, :next_id) return val&.to_i || 1 end # PostgreSQL — try sequence first, auto-create if missing if @driver_name == "postgres" seq_name = generator_name || "#{table.downcase}_#{pk_column.downcase}_seq" begin rows = drv.execute_query("SELECT nextval('#{seq_name}') AS next_id") row = rows.is_a?(Array) ? rows.first : nil val = row_value(row, :next_id) || row_value(row, :nextval) return val.to_i if val rescue # Sequence does not exist — auto-create it seeded from MAX begin max_rows = drv.execute_query("SELECT COALESCE(MAX(#{pk_column}), 0) AS max_id FROM #{table}") max_row = max_rows.is_a?(Array) ? max_rows.first : nil max_val = row_value(max_row, :max_id) start_val = max_val ? max_val.to_i + 1 : 1 drv.execute("CREATE SEQUENCE #{seq_name} START WITH #{start_val}") drv.commit rescue nil rows = drv.execute_query("SELECT nextval('#{seq_name}') AS next_id") row = rows.is_a?(Array) ? rows.first : nil val = row_value(row, :next_id) || row_value(row, :nextval) return val&.to_i || start_val rescue # Fall through to sequence table fallback end end end # SQLite / MySQL / MSSQL / PostgreSQL fallback — atomic sequence table seq_key = generator_name || "#{table}.#{pk_column}" sequence_next(seq_key, table: table, pk_column: pk_column) end |
#insert(table, data) ⇒ Object
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 |
# File 'lib/tina4/database.rb', line 473 def insert(table, data) cache_invalidate if @cache_enabled drv = current_driver # List of hashes — batch insert if data.is_a?(Array) return { success: true, affected_rows: 0 } if data.empty? keys = data.first.keys.map(&:to_s) placeholders = drv.placeholders(keys.length) sql = "INSERT INTO #{table} (#{keys.join(', ')}) VALUES (#{placeholders})" params_list = data.map { |row| keys.map { |k| row[k.to_sym] || row[k] } } return execute_many(sql, params_list) end columns = data.keys.map(&:to_s) placeholders = drv.placeholders(columns.length) sql = "INSERT INTO #{table} (#{columns.join(', ')}) VALUES (#{placeholders})" drv.execute(sql, data.values) { success: true, last_id: drv.last_insert_id } end |
#pool_size ⇒ Object
Returns the configured pool size, or 1 for single-connection mode.
753 754 755 |
# File 'lib/tina4/database.rb', line 753 def pool_size @pool_size > 0 ? @pool_size : 1 end |
#rollback ⇒ Object
Roll back the current transaction and release the driver pin.
Rollback is the terminal cleanup of a transaction, so it ALWAYS clears the pin (and the depth counter) — even after a failed commit it routes to the retained pinned connection and cleans it up. If the underlying rollback itself raises, @last_error is captured and the error re-raised, but the pin is still released so a poisoned connection doesn’t stay pinned forever.
694 695 696 697 698 699 700 701 702 703 |
# File 'lib/tina4/database.rb', line 694 def rollback current_driver.rollback @last_error = nil rescue => e @last_error = e. raise ensure Thread.current[@tx_pin_key] = nil Thread.current[@tx_depth_key] = nil end |
#start_transaction ⇒ Object
Begin a transaction without a block — matches PHP/Python/Node API. Pins the driver to this thread for the whole transaction so executes and the final commit/rollback all run on the same connection.
Nested-begin guard (v3.13.37, DB-contract C): a second start_transaction on a thread that already holds the pin is a double-begin — the inner BEGIN silently commits or no-ops on most engines, leaving the connection mid-transaction with the caller none the wiser. We keep a per-thread depth counter and log a clear warning instead of silently re-beginning. The pin stays on the original driver so commit/rollback still land on the right connection.
640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 |
# File 'lib/tina4/database.rb', line 640 def start_transaction pinned = Thread.current[@tx_pin_key] if pinned depth = (Thread.current[@tx_depth_key] || 1) Tina4::Log.warning( "start_transaction called while a transaction is already open on this " \ "thread (depth would become #{depth + 1}). Nested transactions are not " \ "supported — the existing transaction stays open on its pinned " \ "connection and this nested begin is ignored. Commit or rollback the " \ "outer transaction first." ) Thread.current[@tx_depth_key] = depth + 1 return end drv = current_driver Thread.current[@tx_pin_key] = drv Thread.current[@tx_depth_key] = 1 drv.begin_transaction end |
#table_exists?(table_name) ⇒ Boolean Also known as: table_exists
719 720 721 722 723 724 725 726 727 |
# File 'lib/tina4/database.rb', line 719 def table_exists?(table_name) drv = current_driver # v3.13.14 (#48): drivers that can resolve a schema/catalog-qualified # name ("gift_cards.gift_card", "dbo.widget", "attached.table") answer # directly; the rest fall back to a case-insensitive scan of tables. return drv.table_exists?(table_name) if drv.respond_to?(:table_exists?) tables.any? { |t| t.downcase == table_name.to_s.downcase } end |
#tables ⇒ Object Also known as: get_tables
705 706 707 |
# File 'lib/tina4/database.rb', line 705 def tables current_driver.tables end |
#transaction ⇒ Object
614 615 616 617 618 619 620 621 622 623 624 625 626 627 |
# File 'lib/tina4/database.rb', line 614 def transaction drv = current_driver Thread.current[@tx_pin_key] = drv Thread.current[@tx_depth_key] = 1 drv.begin_transaction yield self drv.commit rescue => e drv.rollback if drv raise e ensure Thread.current[@tx_pin_key] = nil Thread.current[@tx_depth_key] = nil end |
#update(table, data, filter = {}, params = nil) ⇒ Object
494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 |
# File 'lib/tina4/database.rb', line 494 def update(table, data, filter = {}, params = nil) cache_invalidate if @cache_enabled drv = current_driver # String filter with explicit params array if filter.is_a?(String) && !params.nil? set_parts = data.keys.map { |k| "#{k} = #{drv.placeholder}" } sql = "UPDATE #{table} SET #{set_parts.join(', ')}" sql += " WHERE #{filter}" unless filter.empty? drv.execute(sql, data.values + Array(params)) return { success: true } end set_parts = data.keys.map { |k| "#{k} = #{drv.placeholder}" } where_parts = filter.keys.map { |k| "#{k} = #{drv.placeholder}" } sql = "UPDATE #{table} SET #{set_parts.join(', ')}" sql += " WHERE #{where_parts.join(' AND ')}" unless filter.empty? values = data.values + filter.values drv.execute(sql, values) { success: true } end |