Skip to content

Latest commit

 

History

History
155 lines (113 loc) · 4.48 KB

INSTALL.md

File metadata and controls

155 lines (113 loc) · 4.48 KB
Raw

Notes about installation Mongo Foreign Data Wrapper

To compile the MongoDB foreign data wrapper for PostgreSQL, mongo-c and json-c libraries are needed. To build and install mongo-c and json-c libraries, there are two ways. You can either use script autogen.sh or you can manually perform all required steps listed.

Notes about new MongoDB C Driver support

The current implementation is based on the driver version 1.17.3 of MongoDB.

Installation using script

Number of manual steps needs to be performed to compile and install required mongo-c and json-c libraries. If you want to avoid the manual steps, there is a shell script available which will download and install the appropriate drivers and libraries for you.

Here is how it works:

To install mongo-c and json-c libraries at custom locations, you need to export environment variables MONGOC_INSTALL_DIR and JSONC_INSTALL_DIR respectively. If these variables are not set then these libraries will be installed in the default location. Please note that you need to have the required permissions on the directory where you want to install the libraries.

  • autogen.sh

The script autogen.sh will do all the necessary steps to build with mongo-c driver accordingly.

Steps for manual installation

mongo-c

  1. Download and extract source code of mongoc driver for version 1.17.3

    wget https://github.com/mongodb/mongo-c-driver/releases/download/1.17.3/mongo-c-driver-1.17.3.tar.gz
tar xzf mongo-c-driver-1.17.3.tar.gz
rm -rf mongo-c-driver
mv mongo-c-driver-1.17.3 mongo-c-driver
cd mongo-c-driver

  2. Configure mongoc driver

    cmake -DENABLE_AUTOMATIC_INIT_AND_CLEANUP=OFF .

    To install at custom location:

    cmake -DCMAKE_INSTALL_PREFIX=YOUR_INSTALLATION_DIRECTORY -DENABLE_AUTOMATIC_INIT_AND_CLEANUP=OFF .

  3. Compile and install

    cmake --build .
cmake --build . --target install

For more details on installation of mongo-c driver, you can refer here.

json-c

  1. Download and extract source code

    wget https://github.com/json-c/json-c/archive/json-c-0.15-20200726.tar.gz
tar -xzf json-c-0.15-20200726.tar.gz
rm -rf json-c
mv json-c-json-c-0.15-20200726/ json-c
cd json-c

  2. Configure

    cmake .

    To install at custom location:

    cmake -DCMAKE_INSTALL_PREFIX=YOUR_INSTALLATION_DIRECTORY .

  3. Compile and install

    make
make install

For more details on installation of json-c library, you can refer here.

Mongo_fdw configuration, compilation and installation

The PKG_CONFIG_PATH environment variable must be set to mongo-c-driver source directory for successful compilation as shown below,

export PKG_CONFIG_PATH=$YOUR_MONGO_FDW_SOURCE_DIR/mongo-c-driver/src/libmongoc/src:$YOUR_MONGO_FDW_SOURCE_DIR/mongo-c-driver/src/libbson/src

The LD_LIBRARY_PATH environment variable must include the path to the mongo-c installation directory containing the libmongoc-1.0.so and libbson-1.0.so files. For example, assuming the installation directory is /home/mongo-c and the libraries were created under it in lib64 sub-directory, then we can define the LD_LIBRARY_PATH as:

export LD_LIBRARY_PATH=/home/mongo-c/lib64:$LD_LIBRARY_PATH

Note: This LD_LIBRARY_PATH environment variable setting must be in effect when the pg_ctl utility is executed to start or restart PostgreSQL or EDB Postgres Advanced Server.

  1. To build on POSIX-compliant systems you need to ensure the pg_config executable is in your path when you run make. This executable is typically in your PostgreSQL installation's bin directory. For example:

    export PATH=/usr/local/pgsql/bin/:$PATH

  2. Compile the code using make.

    make USE_PGXS=1

  3. Finally install the foreign data wrapper.

    make USE_PGXS=1 install

  4. Running regression test.

    make USE_PGXS=1 installcheck

    However, make sure to set the MONGO_HOST, MONGO_PORT, MONGO_USER_NAME, and MONGO_PWD environment variables correctly. The default settings can be found in the mongodb_init.sh script.

If you run into any issues, please let us know.