Quickstart With QueryDeck
Last updated
Last updated
QueryDeck is a powerful tool that can work with your Postgres Database and help you create powerful APIs in realtime.
If you're just getting started with QueryDeck, we'll walk you through the setup process in this guide, so you can get started quickly and easily.
Navigate to https://app.querydeck.io/auth/register, and create a new QueryDeck account.
On creating an account, QueryDeck automatically redirects you to the new app creation page.
If you already have an account, you can create a new project by clicking the +New App CTA on the apps page.
To connect your database with QueryDeck, you get two options:
Connection String OR Details Based
Schema Details Based
The following details are mandatory for you to create your app with the help of connection details :
DB Host
DB Username
DB Password
DB Port
DB Name
OR you can directly connect your connection string and create your app. Connection string provides essential information, such as the database type, server address, credentials, and configuration options.
Connection string can look something like this Host=myServerAddress;Port=5432;Database=myDataBase;UserId=myUsername;Password=myPassword;
Note: Please ensure that you check the confirmation box stating: "I have allowed connections to my database from QueryDeck's IP address: {IP_Address}."
This step is crucial because it ensures that your PostgreSQL database is accessible to QueryDeck.
In order to get started with Schema based connection, you can use the query provided by Querydeck to generate the schema.
It's a purely read-only query. The query performs metadata retrieval in your PostgreSQL database. It queries system catalogs to extract detailed information about tables and their columns, constraints, and relationships (like primary keys, unique keys, and foreign keys).
Post running the query on your database, you can export the complete JSON file and your complete schema can be just copy-pasted into the empty field box.
Hit on Create App +to create your connection and start working on creating REST APIs with QueryDeck.
