https://github.com/piotrkowalczuk/pqt

Postgres schema definition, sql/go, code generation package.
https://github.com/piotrkowalczuk/pqt

code-generation data-access-layer entity golang orm postgresql sql

Last synced: 8 days ago
JSON representation

Postgres schema definition, sql/go, code generation package.

• Host: GitHub
• URL: https://github.com/piotrkowalczuk/pqt
• Owner: piotrkowalczuk
• License: mit
• Created: 2016-01-07T03:12:19.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-01-16T14:59:21.000Z (10 months ago)
• Last Synced: 2024-06-21T15:22:52.276Z (5 months ago)
• Topics: code-generation, data-access-layer, entity, golang, orm, postgresql, sql
• Language: Go
• Homepage: https://godoc.org/github.com/piotrkowalczuk/pqt
• Size: 2.71 MB
• Stars: 68
• Watchers: 4
• Forks: 8
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# pqt [![GoDoc](https://godoc.org/github.com/piotrkowalczuk/pqt?status.svg)](http://godoc.org/github.com/piotrkowalczuk/pqt) ![go workflow](https://github.com/piotrkowalczuk/pqt/actions/workflows/go.yml/badge.svg?branch=piotrkowalczuk/gh-action)

This package is a toolbox for Postgres driven applications.

It provides multiple tools to help to work with Postgres efficiently.

In comparison to other currently available libraries instead of pushing struct tags into anti-pattern or parsing SQL, it allows defining schema programmatically.

From a developer perspective, pqt is primarily a toolkit generator, not an ORM. 

It means it is focusing on bringing low-level building blocks. 

[Generated DAL](https://github.com/piotrkowalczuk/pqt/wiki/Features#data-access-layer) (Data Access Layer) is only a (desired) side effect, a proof that those components fit together well.

A developer gets full access to the internals. 

Building your own, type-safe logic takes minutes. 

As a result, transition in and out is easy. 

No fear that you will be stuck with an ORM that doesn't meet your requirements anymore.

## Documentation

* wiki

    * [Features](https://github.com/piotrkowalczuk/pqt/wiki/Features)

    * [Entities](https://github.com/piotrkowalczuk/pqt/wiki/Entities)

    * [Types](https://github.com/piotrkowalczuk/pqt/wiki/Types)

    * [Repositories](https://github.com/piotrkowalczuk/pqt/wiki/Repositories)

    * [Error Handling](https://github.com/piotrkowalczuk/pqt/wiki/Error-Handling)

* godoc 

    * [pqt](http://godoc.org/github.com/piotrkowalczuk/pqt)

    * [pqtgo](http://godoc.org/github.com/piotrkowalczuk/pqt/pqtgo)

    * [pqtsql](http://godoc.org/github.com/piotrkowalczuk/pqt/pqtsql)

## Example

The package itself does not provide any command line application that would generate output out of given input. 

Instead, it encourages to write local generation application next to the proper package. 

A good example of how such an application could be structured can be found in [examples](https://github.com/piotrkowalczuk/pqt/tree/master/example).

By default, the example is trying to connect to local `test` database on the default port.

To run it simply call:

```bash

$ make gen // not necessary, since generated code is already part of the repo

$ make run

```

## Plugins 

[pqtgo](github.com/piotrkowalczuk/pqt/pqtgo) supports plugins over the [interface](https://godoc.org/github.com/piotrkowalczuk/pqt/pqtgo#Plugin).

* [ntypespqt](github.com/piotrkowalczuk/ntypes)

* [qtypespqt](github.com/piotrkowalczuk/qtypes)

## Contribution

TODO