Skip to content

Add adhoc option to control prepared-statement caching #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pimpin wants to merge 1 commit into
base: pimpin/n1ql-positional-params-v2
Choose a base branch
from
+11 −7
Open

Add adhoc option to control prepared-statement caching #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions lib/couchbase-orm/n1ql.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ def self.sanitize(value)
def self.config(new_config = nil)
Thread.current['__couchbaseorm_n1ql_config__'] = new_config if new_config
Thread.current['__couchbaseorm_n1ql_config__'] || {
scan_consistency: DEFAULT_SCAN_CONSISTENCY
scan_consistency: DEFAULT_SCAN_CONSISTENCY,
adhoc: true
}
end
Comment on lines 23 to 29

@gemini-code-assist gemini-code-assist Bot Jun 24, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

Currently, if a user configures a single option (e.g., CouchbaseOrm::N1ql.config({ adhoc: false })), the entire thread-local configuration hash is overwritten. This causes other configuration options (like scan_consistency) to be lost and default to nil instead of their default values.

To prevent partial configurations from wiping out other defaults, we should merge the new configuration into the existing thread-local configuration, and always merge the thread-local configuration on top of the default configuration hash.

        def self.config(new_config = nil)
            if new_config
                Thread.current['__couchbaseorm_n1ql_config__'] = (Thread.current['__couchbaseorm_n1ql_config__'] || {}).merge(new_config)
            end
            {
                scan_consistency: DEFAULT_SCAN_CONSISTENCY,
                adhoc: true
            }.merge(Thread.current['__couchbaseorm_n1ql_config__'] || {})
        end


Expand Down Expand Up @@ -130,10 +131,11 @@ def run_query(keys, values, query_fn, custom_order: nil, descending: false, limi
limit = build_limit(limit)
n1ql_query = "select raw meta().id from `#{bucket_name}` where #{where} order by #{order} #{limit}"

query_options = options.merge(positional_parameters: params)
adhoc = options.delete(:adhoc) { CouchbaseOrm::N1ql.config[:adhoc] }
query_options = options.merge(positional_parameters: params, adhoc: adhoc)
result = cluster.query(n1ql_query, Couchbase::Options::Query.new(**query_options))
CouchbaseOrm.logger.debug {
"N1QL query: #{n1ql_query} params: #{params.inspect} return #{result.rows.to_a.length} rows with scan_consistency: #{options[:scan_consistency]}"
"N1QL query: #{n1ql_query} params: #{params.inspect} return #{result.rows.to_a.length} rows with scan_consistency: #{options[:scan_consistency]} adhoc: #{adhoc}"
}
N1qlProxy.new(result)
end
Expand Down
2 changes: 2 additions & 0 deletions lib/couchbase-orm/relation.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,8 @@ def build_update_with_params(params, **cond)
def build_query_options(positional_parameters: [])
opts = { scan_consistency: CouchbaseOrm::N1ql.config[:scan_consistency] }
opts[:positional_parameters] = positional_parameters unless positional_parameters.empty?
adhoc = CouchbaseOrm::N1ql.config[:adhoc]
opts[:adhoc] = adhoc unless adhoc.nil?
Couchbase::Options::Query.new(**opts)
end

Expand Down
8 changes: 4 additions & 4 deletions spec/n1ql_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,25 +174,25 @@ class N1QLTest < CouchbaseOrm::Base
N1QLTest.by_rating_reverse()
expect(CouchbaseOrm.logger).to have_received(:debug).at_least(:once) do |&block|
msg = block ? block.call : nil
msg == "N1QL query: select raw meta().id from `#{CouchbaseOrm::Connection.bucket.name}` where type=$1 order by name DESC params: [\"n1_ql_test\"] return 0 rows with scan_consistency: #{described_class::DEFAULT_SCAN_CONSISTENCY}"
msg == "N1QL query: select raw meta().id from `#{CouchbaseOrm::Connection.bucket.name}` where type=$1 order by name DESC params: [\"n1_ql_test\"] return 0 rows with scan_consistency: #{described_class::DEFAULT_SCAN_CONSISTENCY} adhoc: true"
end
end

it "should log the set scan_consistency when n1ql query is executed with a specific scan_consistency" do
allow(CouchbaseOrm.logger).to receive(:debug)
default_n1ql_config = CouchbaseOrm::N1ql.config
CouchbaseOrm::N1ql.config({ scan_consistency: :not_bounded })
CouchbaseOrm::N1ql.config({ scan_consistency: :not_bounded, adhoc: true })
N1QLTest.by_rating_reverse()
expect(CouchbaseOrm.logger).to have_received(:debug).at_least(:once) do |&block|
msg = block ? block.call : nil
msg == "N1QL query: select raw meta().id from `#{CouchbaseOrm::Connection.bucket.name}` where type=$1 order by name DESC params: [\"n1_ql_test\"] return 0 rows with scan_consistency: not_bounded"
msg == "N1QL query: select raw meta().id from `#{CouchbaseOrm::Connection.bucket.name}` where type=$1 order by name DESC params: [\"n1_ql_test\"] return 0 rows with scan_consistency: not_bounded adhoc: true"
end

CouchbaseOrm::N1ql.config(default_n1ql_config)
N1QLTest.by_rating_reverse()
expect(CouchbaseOrm.logger).to have_received(:debug).at_least(:once) do |&block|
msg = block ? block.call : nil
msg == "N1QL query: select raw meta().id from `#{CouchbaseOrm::Connection.bucket.name}` where type=$1 order by name DESC params: [\"n1_ql_test\"] return 0 rows with scan_consistency: #{described_class::DEFAULT_SCAN_CONSISTENCY}"
msg == "N1QL query: select raw meta().id from `#{CouchbaseOrm::Connection.bucket.name}` where type=$1 order by name DESC params: [\"n1_ql_test\"] return 0 rows with scan_consistency: #{described_class::DEFAULT_SCAN_CONSISTENCY} adhoc: true"
end
end

Expand Down