Contents

# solrwrapper

Wrap any task with a Solr instance:

```ruby
SolrWrapper.wrap do |solr|
  # Something that requires Solr
end
```

Or with Solr and a solr collection:

```ruby
SolrWrapper.wrap do |solr|
  solr.with_collection(dir: File.join(FIXTURES_DIR, "basic_configs")) do |collection_name|
  end
end
```

## Basic Options

```ruby
SolrWrapper.wrap port: 8983,
                 verbose: true,
                 managed: true,
                 instance_dir: '/opt/solr'
```

Options:

|Option         |                                         |
|---------------|-----------------------------------------|
| instance_dir  | Directory to store the solr index files |
| url           | URL of the Zip file to download |
| version       | Solr version to download and install |
| port          | port to run Solr on |
| version_file  | Local path to store the currently installed version |
| download_dir  | Local path for storing the downloaded Solr zip file |
| solr_zip_path | Local path to the Solr zip file |
| md5sum        | Path/URL to MD5 checksum |
| solr_xml      | Path to Solr configuration |
| verbose       | (Boolean) |
| managed       | (Boolean) |
| ignore_md5sum | (Boolean) |
| solr_options  | (Hash) |
| env           | (Hash) |

```ruby
solr.with_collection(name: 'collection_name', dir: 'path_to_solr_configs')
```

## From the command line

```console
$ solr_wrapper -p 8983
```

## Rake tasks

SolrWrapper provides rake tasks for installing, starting and stopping solr.  To include the tasks in your Rake environment, add this to your Rakefile

```ruby
  require 'solr_wrapper/rake_task'
```

You can configure the tasks by setting `SolrWrapper.default_instance_options`.  For example:

```ruby
SolrWrapper.default_instance_options = {
    verbose: true,
    cloud: true,
    port: '8888',
    version: '5.3.1',
    instance_dir: 'solr',
    download_dir: 'tmp'
}
require 'solr_wrapper/rake_task'
```

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
solr_wrapper-0.11.0	README.md