Learn How to Set Up GitPod Environment for Text to SQL Project

Learn How to Set Up GitPod Environment for Text to SQL Project

Table of Contents

• Introduction
• Setting Up the GitPod Environment
• Replacing the API Key
• Making the Port Public
• Installing Dependencies
• Starting the Server
• Making the Server URL Public
• Pushing Dummy Data
• Replacing the API Endpoint
• Generating Smaller Data Set
• Running the Script
• Updating the Schema ID
• Updating the Request
• Conclusion

Introduction

In this video, I will guide you on how to set up a GitPod environment for a text to SQL project. The project files can be found at link. Follow the steps provided in the contribution.md file to complete the setup process.

Setting Up the GitPod Environment

To set up the GitPod environment, click on the "Open in GitPod" button in the quick start guide of the project. This will open a workspace with Docker containers. Wait for the containers to be set up.

Replacing the API Key

Open the .env file and replace the default API key with your own API key. If you don't have an API key, sign up for a new account and create one. Save the file after replacing the key.

Making the Port Public

To make the port public, go to Ports and click on the option to make port 8084 public. This will allow external access to the server.

Installing Dependencies

Next, open a new terminal and execute a shell script that installs all the project dependencies. This script will install the required dependencies listed in the requirement.txt and source/server/SQL graph files. If any dependencies are missing, run the shell script again.

Starting the Server

Start the server by running the command provided in the contribution.md file. This will start the server and display a URL on which the server can be accessed.

Making the Server URL Public

Make the server URL public by clicking on the option in Ports. This will remove the need for an authentication token to access the URL on GitPod.

Pushing Dummy Data

To push dummy data to the database, go to the specified location and replace the API endpoint with the correct address. This address can be found in the Source/server/DB/mock_data shell script. Execute the shell script to push the dummy data to the database.

Replacing the API Endpoint

In the contribution.md file, update the call request with the schema ID. Copy the schema ID from the schema/id.txt file. Replace the URL with the address of the running port.

Generating Smaller Data Set

If you want a smaller data set for testing purposes, open the education_data.poi file and change the generate School data function to generate a smaller set of data.

Running the Script

To execute the commands in step 10, navigate to the specified directory and run the provided script. Wait for the script to complete the data insertion process.

Updating the Schema ID

Copy the schema ID from the schema/id.txt file and paste it into step 12 to update the call request.

Updating the Request

Replace the URL in the call request with the correct address of the running port. Copy the updated request and paste it into the terminal to test if everything is working fine.

Conclusion

By following the steps Mentioned above, you have successfully set up the GitPod environment for the text to SQL project. You can now access the server and work with the provided data. Happy coding!

🔍 Highlights

• Set up a GitPod environment for a text to SQL project
• Replace the default API key with your own API key
• Make the server URL public for easy access
• Push dummy data to the database for testing
• Update the call request with the schema ID and URL
• Execute the provided scripts for installation and data insertion

FAQ:

Q: Where can I find the project files? A: The project files can be found at link.

Q: How do I replace the API key? A: Open the .env file and replace the default API key with your own API key.

Q: How do I make the server URL public? A: Go to Ports and click on the option to make the server URL public.

Q: How do I push dummy data to the database? A: Replace the API endpoint in the specified file and execute the shell script provided.

Q: What should I do if some dependencies are missing? A: Run the shell script again to install all the required dependencies.

Q: How do I update the call request with the schema ID? A: Copy the schema ID from the specified file and replace it in the call request.

Q: Where can I find a smaller data set for testing? A: Open the education_data.poi file and change the generate School data function for a smaller data set.