Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Texticle exposes full text search capabilities from PostgreSQL, and allows you to declare full text indexes. Texticle will extend ActiveRecord with named_scope methods making searching easy and fun!
branch: master

This branch is 55 commits ahead, 1 commit behind ecin:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
rails
test
.autotest
.gitignore
CHANGELOG.rdoc
Manifest.txt
README.rdoc
Rakefile
texticle.gemspec

README.rdoc

texticle

DESCRIPTION:

Texticle exposes full text search capabilities from PostgreSQL, and allows you to declare full text indexes. Texticle will extend ActiveRecord with named_scope methods making searching easy and fun!

FEATURES/PROBLEMS:

  • Only works with PostgreSQL

SYNOPSIS:

Rails 3 Configuration

In the project's Gemfile add

gem 'texticle', '1.0.4'

Rails 2 Configuration

In environment.rb:

config.gem 'texticle'

In your Rakefile:

require 'rubygems'
require 'texticle/tasks'

Usage

Declare your index in your model:

class Product < ActiveRecord::Base
  index do
    name
    description
  end
end

Use the search method

Product.search('hello world')

Full text searches can be sped up by creating indexes. To create them, run:

$ rake texticle:create_indexes

Alternatively, you can create a migration that will build your indexes:

$ rake texticle:migration

BETA: FUZZY SEARCH

We're adding support for Postgres' optional trigram matching module, which allows for fuzzier text searches.

Since it's an optional module, first step is to install it into the current database: $ rake texticle:install_trigram

If you installed Postgres with its optional 'contrib' modules, you should be safe.

Declare your indexes as you normally would:

class Book < ActiveRecord::Base index { title } end Finally, say hello to #tsearch:

Book.create :title => “_why's Poignant Guide to Ruby” Book.tsearch “_whys Poignnt Gd t Rb” # => [#<Book title: “_why's Poignant Guide to Ruby”>] Trigram searching is still in beta, so expect the API to change and/or improve.

REQUIREMENTS:

  • Texticle may be used outside rails, but works best with rails.

INSTALL:

  • sudo gem install texticle

LICENSE:

(The MIT License)

Copyright © 2009 Aaron Patterson

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.