https://github.com/jaystack/odata-v4-server-pgsql-example
Postgres example for odata-v4-server
https://github.com/jaystack/odata-v4-server-pgsql-example
Last synced: about 2 months ago
JSON representation
Postgres example for odata-v4-server
- Host: GitHub
- URL: https://github.com/jaystack/odata-v4-server-pgsql-example
- Owner: jaystack
- Created: 2016-11-25T09:41:56.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-06-13T04:29:36.000Z (almost 8 years ago)
- Last Synced: 2025-03-27T08:11:22.524Z (2 months ago)
- Language: JavaScript
- Size: 35.2 KB
- Stars: 10
- Watchers: 11
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# odata-v4-server-pgsql-example
PostgreSQL Server example for **[JayStack OData V4 Server](https://github.com/jaystack/odata-v4-server)**
## About JayStack OData V4 Server (odata-v4-server)
With JayStack OData v4 Server you can build your own data endpoints without the hassle of implementing any protocol-level code. This framework binds OData v4 requests to your annotated controller functions, and compiles OData v4 compatible response. Clients can access services through OData-compliant HTTP requests. We recommend the JayData library for consuming OData v4 APIs.
This example uses **JayStack OData V4 Server [(odata-v4-server)](https://github.com/jaystack/odata-v4-server)** and [odata-v4-pgsql](https://github.com/jaystack/odata-v4-pgsql) repositories.
You can read more about **JayStack OData V4 Server** in our tutorial at ...
Also there are sevaral other examples on **JayStack OData V4 Server (odata-v4-server)**:
- [client example using React](https://github.com/jaystack/odata-v4-server-react-client-example)
- [server example using MySql](https://github.com/jaystack/odata-v4-mysql-example)
- [server example using MSSql](https://github.com/jaystack/odata-v4-server-mssql-example)
- [server example using MongoDb](https://github.com/jaystack/odata-v4-server-mongodb-example)
## Technical details of this example
### Setting up the database
You have to create the database manually using this command after connecting to the default database:
```SQL
CREATE DATABASE northwind;
```
### Setting up the connection
You may customize the db connection options
by editing [connect.ts](https://github.com/jaystack/odata-v4-server-pgsql-example/blob/master/src/utils/connect.ts#L29-L30).
By default, these are the options:
```js
const pool = new pg.Pool({
user: 'postgres',
password: 'postgres',
database: 'northwind'
});
```
By default, the database will listen on `port` `5432` therefore it is not set above.
### Building the application
```
npm run build
```
### Testing the application
```
npm test
```
### Starting the application
```
npm start
```
### Creating sample data
After starting the application (it will listen on `localhost:3000` by default) you can generate / recreate the sample dataset
by submitting [localhost:3000/initDb](http://localhost:3000/initDb).
Alternatively if you start unit tests (`npm test`) then the database will be initialized automatically.