Skip to content

Latest commit

 

History

History
60 lines (36 loc) · 2.68 KB

README.md

File metadata and controls

60 lines (36 loc) · 2.68 KB
Raw

numtel:pg-server Build Status

Package to run PostgreSQL server inside your Meteor app

Version 1.0.0 breaking change: Default data directory has now changed. If you do not specify a data directory in your .pg.json file, you will need to now specify the old default data directory in order to migrate successfully without losing your current databases (or move your data directory to the new default location, see "Configuring the server" section below). Set the datadir key to .meteor/postgresdb to maintain the old default data directory.

Installation

Currently only supports Linux (32 and 64 bit) and Mac OSX (64 bit). Windows support is expected in the near future.

Add this package to your application to embed a PostgreSQL server:

meteor add numtel:pg-server

Configuring the server

A settings file must be created with the extension of .pg.json in your application. A file name like myapp.pg.json is valid.

If a datadir setting is not specified, the PostgreSQL data will default to your application's .meteor/local/postgresdb directory. The directory will be created if it does not exist.

When specifying a datadir setting, the path is relative to your application root.

Optionally, set a boolean value for the output_stderr key to true in order to display full ouput of STDERR from the PostgreSQL server process.

Initialization queries

In your .pg.json file, you may specify a filename containing queries to perform on first installation of the database under the initialize key. These queries will be executed if the data directory is created when the Meteor application is started.

Example configuration

See test.pg.json for an example. Settings are used to build the postgres.conf file. Specifying a port is recommended.

Usage

With the start of you Meteor application, you will notice a new line output to the console:

=> Started PostgreSQL.

The PostgreSQL server is started on the local machine and may be used with the numtel:pg package by using the following connection string:

var CONN_STR = 'postgres://'
  + process.env.USER + ':' // Default user is same as system user
  + 'numtel'               // From defaultpw file in NPM package
  + '@localhost:' + PORT   // Port as specified in .pg.json file (default: 5432)
  + '/postgres';           // Default database

Resources

License

MIT