Intro

Ponder is an ORM for PostGres using the Deno runtime. It eliminates the need for developers to spend valuable time writing complex SQL queries.

Features

• Connect to your PostGres Database
• Basic CRUD functionality for interacting with your PostGRES Database
• Introspect database and modify database tables through models in accordance with principles of OOP
• Introspect your database for a visual representation of your tables

How to add to your Project

import * as ponder from "https://deno.land/x/ponder/";

Connecting Your Database

Create a new instance of poolConnection passing in the database connection string. By default, the number of pool connections is set to three and lazy loading is enabled. Users may also specify the number of server connections and whether the loading type is lazy.

import { poolConnection } from'./deps.ts

const ponder = new poolConnection('PG_URI')

const ponder = new poolConnection('PG_URI', 5, false)

BasicCRUD

Find a Table

const data = await ponder.findAllinOne('people');

Find a Column in a Table

const data = await ponder.findColumn('age', 'people');

Find a Row in a Table

const data = await ponder.findRow('people', 'hair', 'brown');

Find a Cell in a Table

ponder.findCell('people', 'name', 'corey');

Add a Row to a Table

ponder.insertIntoTable('people', ['name', 'hair'], ['Sam', 'red']);

Update a Column in a Table

ponder.updateTable(people, [hair_color, eye_color], ['blonde', 'hazel'], [name, birth_year], ['Anton', '1860'], 'or');

Delete a row on a Table

ponder.deleteRow(hair_color, ['blonde', 'pink'], ['Clementine']);

ManagingTables

Create Table

ponder.createTable('Cats', {
    id: ["SERIAL"]
    areCute: ["VARCHAR", "20", "NOT NULL"]
    }); 

Drop One Table

ponder.dropOneTable('Cats', true);

Drop Multiple Tables

ponder.dropMultipleTables(['Cats', 'People'], true);

Add Columns to an Existing Table

ponder.addColumns('programmers', {
    id: ["SERIAL"]
    howSmart: ["VARCHAR", "20", "NOT NULL"]
 });

Drop Columns from a Table

ponder.dropColumns('programmers', columnsToDrop: {howSmart: true});

Database Introspection

Ponder provides an introspect method to receive JavaScript representations of the data in your SQL Table. Because running the introspect method will create/write a new file in your file system, it is recommended to create a new file in your project root directory. Run this file using deno run to execute introspection. (If you keep your instrospect execution within another file, it may run repeated on the same database and will write unnecessary duplicates in your file system).
After importing ponder from your deps.ts file or from ponder directly, you'll need to first connect your database. After making a connection, all you need to do is invoke instrospect function:

ponder.introspect();

import { Model } from './deps.ts' 

  export class person extends Model { 
  tableName = 'person' 
   static person_id = { 
      data_type: 'integer', 
      is_nullable: 'NO', 
      } 
   static name = { 
      data_type: 'character varying', 
      is_nullable: 'YES', 
      } 
   static hair_color = { 
      data_type: 'character varying', 
      is_nullable: 'YES', 
      } 
   static age = { 
      data_type: 'integer', 
      is_nullable: 'YES', 
      }  
    }

export interface person { 
      name: string; 
      hair_color: string; 
      age: number; 
      height: number; 
      favorite_movie: string; 
      favorite_book: string; 
    } 

Model Methods

const newPerson = new person();

newPerson.name = 'Sara';
newPerson.hair_color = 'dark brown';

Save new row to table

newPerson.save();

Update a row

newPerson.name = 'Johannes';
newPerson.hair_color = 'black';
newPerson.age = 22;
//Invoking update function makes these changes in database
newPerson.update();
    

Search all entries in table

newPerson.search();

Delete from table

newPerson.delete()

Associations

Currently under development!

Ponder Command Line Interface (CLI)

Coming Soon! A feature for the future!

Making Contributions & Finding Bugs

To make contributions, create a fork of the dev branch. Please be sure to utilize the Deno Typescript linter. Ensure that any changes made are reflected in the documentation. Make a pull request to the Dev branch when you have finished making your changes, note that once submitted any changes made will be covered under the MIT license. Feel free to contact the maintainers with any questions or concerns.

Finding Bugs

License

About Ponder and its Creators

Matt Connell

Software Engineer

GitHub
LinkedIn

Sam Goldenberg

Software Engineer

GitHub
LinkedIn

Stella Baek

Software Engineer

GitHub
LinkedIn

Corey McClendon-Brown

Software Engineer

GitHub
LinkedIn

Sara Brown

Software Engineer

GitHub

LinkedIn