Deploy TiDB Starter Kit with Drizzle ORM

This template contains the configurations to build and connect an application to TiDB.

Last updated

View as Markdown Agent setup

The TiDB Starter Kit with Drizzle ORM template contains the configurations for creating and connecting an application to a TiDB database via Drizzle ORM.

The deployment of this template creates a GitHub repository containing your project, as well as an application and a domain to facilitate your access and management through Azion Web Platform. It also creates a new database with a table in your TiDB cluster.

Requirements

  • A GitHub account to connect with Azion and create your new repository.

    • Every push will be deployed automatically to this repository to keep your project updated.

  • A TiDB cluster with space available for a new database.

  • This template uses Application Accelerator, Functions, and Cache, and it may generate usage-related costs. Check the pricing page for more information. Database storage and operations could also generate costs directly by TiDB. Check TiDB’s pricing page for details.

Deploying the template

You can obtain and configure your template through the Azion Console. To easily deploy it on Azion, select the button below.

Deploy

Setting up the template

In the configuration form, you must provide the information to configure your application. Fill in the presented fields.

Fields identified with an asterisk are mandatory.

Connect Azion with your GitHub account
  • A pop-up window will open to confirm the installation of the Azion GitHub App, a tool that connects your GitHub account with Azion’s platform.
  • Define your permissions and repository access as desired.
Select the Git Scope

Select the Git Scope to work with.

Fill in the application information

Fill in the information to set up the application:

  • Application Name: define a unique name for your application, which will be the same for the storage bucket and the function.
  • TiDB Database: the name of the database to be used. If the given name doesn’t exist in the cluster, the template will create it.
  • TiDB Host: the hostname to connect to your TiDB cluster.
  • TiDB Password: the password to be used in the connections to the cluster.
  • TiDB Port: the port used in the connections to the cluster.
  • TiDB User: the username to be used in the connections to the cluster.
Select Deploy

Select the Deploy button to start the deployment process.

During the deployment, you’ll be able to follow the process through a window showing the logs. When it’s complete, the page shows information about the application and some options to continue your journey.

The link to the application allows you to see it on the browser. However, it takes a certain time to propagate and configure the application on Azion’s distributed infrastructure. It may be necessary to wait a few minutes for the URL to be activated and for the application page to be effectively displayed in the browser.

Managing the template

Considering that this initial setup may not be optimal for your specific application, all settings can be customized any time you need by using Azion’s platform.

To manage and edit your application’s settings, follow these steps:

Access Azion Console

Access Azion Console.

Select Applications

On the upper-left corner, select Products menu, the icon with three horizontal lines, > Applications.

  • You’ll be redirected to the Applications page. It lists all the applications you’ve created.
Select your application

Find the application related to your template and select it.

  • The list is organized alphabetically. You can also use the search bar located in the upper-left corner of the list; currently, it filters only by Application Name.

After selecting the application you’ll work on, you’ll be directed to a page containing all the settings you can configure.

Read the documentation about managing applications for more details.

Adding a custom domain

The application created during the deployment has an assigned Azion Workload domain to make it accessible through the browser. The domain has the following format: xxxxxxxxxx.map.azionedge.net/. However, you can add a custom domain for users to access your application through it.

For more information, refer to Add a custom domain to a workload.