https://github.com/numtel/meteor-pg-server
Package to run PostgreSQL server inside your Meteor app
https://github.com/numtel/meteor-pg-server
Last synced: about 1 year ago
JSON representation
Package to run PostgreSQL server inside your Meteor app
- Host: GitHub
- URL: https://github.com/numtel/meteor-pg-server
- Owner: numtel
- License: mit
- Created: 2015-05-07T20:31:49.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2015-10-09T00:13:07.000Z (over 10 years ago)
- Last Synced: 2025-03-04T07:51:20.612Z (about 1 year ago)
- Language: JavaScript
- Size: 146 KB
- Stars: 8
- Watchers: 4
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# numtel:pg-server [](https://travis-ci.org/numtel/meteor-pg-server)
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`](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:
```javascript
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
* [`numtel:pg` - Reactive PostgreSQL for Meteor](https://github.com/numtel/meteor-pg)
* [Leaderboard example modified to use PostgreSQL](https://github.com/numtel/meteor-pg-leaderboard)
## License
MIT