drizzle-postgis

🌐 drizzle-postgis

A Drizzle extension/plugin to help work with PostGIS and GeoJSON

Bug report · Feature request · Read Docs

---

🚸 Disclaimer

I'm a GIS beginner, please let me know if you see anything problematic in the way this library is implemented. The library is also missing support for very many functions, and test coverage exists but is not complete.

🎉 Installation

pnpm add drizzle-postgis

NOTE Unfortunately drizzle-kit has a bug that causes custom types to be quoted. In order to use this with migrations, you need to apply a patch. This is the only solution until this issue is fixed! https://github.com/drizzle-team/drizzle-kit-mirror/issues/350

❓Troubleshooting

If you're having trouble with Postgres complaining that the functions can't be found, try using config.setPostGISSchema("<schema>")

There's more information about how to use these functions here: https://postgis.net/docs/reference.html

📚 Auto generate docs

The project is configured to auto-generate the documentation using typedoc. The documentation is generated in the docs folder.

The documentation will get generated when the code is pushed to the main branch. You can also generate the documentation locally by running the command pnpm run build:docs.

🫱🏻‍🫲🏼 Contributing

Please make sure to follow the conventional commit messages format while making changes. This helps in generating changelogs and versioning the package.

🙏 Thanks to

• 🚧 @akashrajpurohit/ts-npm-template - an opinionated bootstrap template to create NPM packages.
• ⌨️ Typescript with tsup build tool.
• ⚡️ Vitest - Unit Test Framework
• 🚀 Semantic Release - Fully automated version management and package publishing.
• 📖 Typedoc - Generate documentation of your package.
• 🔀 Github Actions - CI pipelines
• 📦 PNPM - Package manager