Description
A unified interface on top of ActiveRecord for case-insensitive string-in-set and prefix querying, and full-text search on SQLite, MySQL, and PostgreSQL
* Case-insensitive string-in-set querying, prefix querying, and case-insensitive index creation.
* Basic full-text search for a list of terms, and FTS index creation.
DbTextSearch alternatives and similar gems
Based on the "ORM/ODM Extensions" category.
Alternatively, view DbTextSearch alternatives based on common mentions on social networks and blogs.
-
ActsAsTaggableOn
A tagging plugin for Rails applications that allows for custom tagging along dynamic contexts. -
Audited
Audited (formerly acts_as_audited) is an ORM extension that logs all changes to your Rails models. -
ActsAsParanoid
ActiveRecord plugin allowing you to hide and restore records without actually deleting them. -
Rails PG Extras
Rails PostgreSQL database performance insights. Locks, index usage, buffer cache hit ratios, vacuum stats and more. -
Acts As Commentable with Threading
Similar to acts_as_commentable; however, utilizes awesome_nested_set to provide threaded comments -
activerecord-multi-tenant
Rails/ActiveRecord support for distributed multi-tenant databases like Postgres+Citus -
ActsAsTree
ActsAsTree -- Extends ActiveRecord to add simple support for organizing items into parent–children relationships. -
activerecord_json_validator
🔩 ActiveRecord::JSONValidator makes it easy to validate JSON attributes against a JSON schema. -
ActiveImporter
DISCONTINUED. Define importers that load tabular data from spreadsheets or CSV files into any ActiveRecord-like ORM. -
PermenantRecords
Rails Plugin - soft-delete your ActiveRecord records. It's like an explicit version of ActsAsParanoid -
data_miner
Download, unpack from a ZIP/TAR/GZ/BZ2 archive, parse, correct, convert units and import Google Spreadsheets, XLS, ODS, XML, CSV, HTML, etc. into your ActiveRecord models. Uses RemoteTable gem internally. -
mini_record
ActiveRecord meets DataMapper, with MiniRecord you are be able to write schema inside your models.
InfluxDB - Power Real-Time Data Analytics at Scale
* Code Quality Rankings and insights are calculated and provided by Lumnify.
They vary from L1 to L5 with "L5" being the highest.
Do you think we are missing an alternative of DbTextSearch or a related project?
README
DbTextSearch
Different relational databases treat text search very differently. DbTextSearch provides a unified interface on top of ActiveRecord for SQLite, MySQL, and PostgreSQL to do:
- Case-insensitive string-in-set querying, prefix querying, and case-insensitive index creation.
- Basic full-text search for a list of terms, and FTS index creation.
Installation
Add this line to your application's Gemfile:
gem 'db_text_search', '~> 0.3.1'
Usage
Case-insensitive string matching
Add an index in a migration to an existing CI (case-insensitive) or CS (case-sensitive) column:
DbTextSearch::CaseInsensitive.add_index connection, :users, :username
# Options: name, unique
Or, create a new CI column:
DbTextSearch::CaseInsensitive.add_ci_text_column connection, :users, :username
Perform a search for records with column that case-insensitively equals to one of the strings in a given set:
# Find all confirmed users that have either the username Alice or Bob (case-insensitively):
DbTextSearch::CaseInsensitive.new(User.confirmed, :username).in(%w(Alice Bob))
#=> ActiveRecord::Relation
Perform a case-insensitive prefix search:
DbTextSearch::CaseInsensitive.new(User.confirmed, :username).prefix('Jo')
See also: API documentation.
Full text search
Add an index:
DbTextSearch::FullText.add_index connection, :posts, :content
# Options: name
Perform a full-text search:
DbTextSearch::FullText.new(Post.published, :content).search('peace')
DbTextSearch::FullText.new(Post.published, :content).search(%w(love kaori))
Under the hood
Case-insensitive string matching
Case-insensitive equality methods Column typeSQLiteMySQLPostgreSQL Detected typesSearch / indexDetected typesSearch / indexDetected typesSearch / index CI always treated as CS COLLATE NOCASE default default CITEXT default CS non-ci collations LOWERno index default LOWER
Case-insensitive prefix matching (using LIKE)
Column typeSQLiteMySQLPostgreSQL
CI
default, cannot always use an index,
even for prefix queries
default
cannot use an index
CS
cannot use an index
LOWER(column text_pattern_ops)
Full-text search
MySQL
A FULLTEXT
index, and a MATCH AGAINST
query. MySQL v5.6.4+ is required.
PostgreSQL
A gist(to_tsvector(...))
index, and a @@ plainto_tsquery
query.
Methods also accept an optional pg_ts_config
argument (default: "'english'"
) that is ignored for other databases.
SQLite
No index, a LIKE %term%
query for each term joined with AND
.
Development
Make sure you have a working installation of SQLite, MySQL, and PostgreSQL.
After checking out the repo, run bin/setup
to install dependencies.
Then, run rake test_all
to run the tests with all databases and gemfiles.
See the Rakefile for other available test tasks.
You can also run bin/console
for an interactive prompt that will allow you to experiment.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/thredded/db_text_search. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
License
The gem is available as open source under the terms of the MIT License.
*Note that all licence references and agreements mentioned in the DbTextSearch README section above
are relevant to that project's source code only.