https://github.com/couchbase/geocouch

GeoCouch, a spatial index for CouchDB
https://github.com/couchbase/geocouch

Last synced: 5 days ago
JSON representation

GeoCouch, a spatial index for CouchDB

• Host: GitHub
• URL: https://github.com/couchbase/geocouch
• Owner: couchbase
• License: apache-2.0
• Created: 2011-03-03T01:31:01.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2021-11-10T12:00:03.000Z (almost 3 years ago)
• Last Synced: 2024-08-01T12:22:38.721Z (3 months ago)
• Language: Erlang
• Homepage:
• Size: 1.34 MB
• Stars: 515
• Watchers: 40
• Forks: 62
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

• Awesome-Geospatial - GeoCouch - GeoCouch is a spatial extension for Couchbase and Apache CouchDB. (Database)
• awesome-erlang - GeoCouch - A spatial extension for Couchbase and Apache CouchDB. (Geolocation)
• awesome-starred - couchbase/geocouch - GeoCouch, a spatial index for CouchDB (others)

README

        
Welcome to the world of GeoCouch

================================

GeoCouch is a spatial extension for Couchbase and Apache CouchDB.

For Couchbase

-------------

For compiling Couchbase (it includes GeoCouch), please see https://github.com/couchbase/tlm

For Apache CouchDB

------------------

This version of GeoCouch needs at least Apache CouchDB 1.3.x.

### Checkout the code

First checkout the source code for Apache CouchDB into a directory that will

be referred to as ``.

Then checkout the GeoCouch source:

    git clone https://github.com/couchbase/geocouch.git

There's a new directory called `geocouch` created. From now on this directory

will be referred to as ``.

### Build instructions

Make sure you have built Apache CouchDB from source including `make dev`. So

go to your `` and run:

    ./bootstrap

    ./configure

    make dev

After that you can compile GeoCouch from within the GeoCouch directory:

    COUCH_SRC=/src/couchdb make couchdb

Now copy the configuration file into your Apache CouchDB directory:

    cp gc-couchdb/etc/couchdb/default.d/geocouch.ini /etc/couchdb/default.d/

### Running Apache CouchDB

Apache CouchDB needs the compiled geocouch in the include path. You can either copy `gc-couchdb` and `vtree` into `/src/` or set the `ERL_LIBS` environment variable to the GeoCouch root directory.

    cd 

    ERL_LIBS="" ./utils/run

### Running tests

After you've followed the build instructions you can run the tests with

    COUCH_SRC=/src/couchdb make couchdb-check

In order to run the JavaScript based tests, you need to start Apache CouchDB first:

    cd 

    ERL_LIBS="" ./utils/run

The tests can either be run from the command line or the browser.

#### From command line

From the command line the easiest way is to use the supplied runner script.

From within the ``:

    cd gc-couchdb

    ./utils/runjstests.sh /test/javascript/run ./share/www/script/test

#### From browser

To run it from the browser first copy the JavaScript tests into the same directory as the other Apache CouchDB tests:

    cp /gc-couchdb/share/www/script/test/* /share/www/script/test/

Then add the tests to `/share/www/script/couch_tests.js`

    loadTest("spatial.js");

    loadTest("list_spatial.js");

    loadTest("etags_spatial.js");

    loadTest("multiple_spatial_rows.js");

    loadTest("spatial_compaction.js");

    loadTest("spatial_design_docs.js");

    loadTest("spatial_bugfixes.js");

    loadTest("spatial_offsets.js");

    loadTest("spatial_range.js");

### More information

For more information and samples please see the [README in the gc-couchdb subdirectory](gc-couchdb/README.md).

License

-------

GeoCouch is licensed under the Apache License 2.0.