{"id":454,"date":"2021-04-28T00:00:00","date_gmt":"2021-04-28T00:00:00","guid":{"rendered":"https:\/\/en.pingcap.com\/blog\/getting-started-with-rails-tidb\/"},"modified":"2024-08-20T06:41:42","modified_gmt":"2024-08-20T13:41:42","slug":"getting-started-with-rails-tidb","status":"publish","type":"post","link":"https:\/\/www.pingcap.com\/ko\/blog\/getting-started-with-rails-tidb\/","title":{"rendered":"Getting Started with Rails & TiDB"},"content":{"rendered":"

An original version of this article was published on dev.to<\/a>.<\/em><\/p>\n

This tutorial, perhaps, is the first Rails + TiDB integration tutorial across the web. TiDB<\/a> is an open-source, distributed SQL database that features horizontal scalability, high availability, and MySQL compatibility.<\/p>\n

For beginners, integrating a complex ORM like ActiveRecord with TiDB could be difficult. Since there are few articles on the web touching this topic, I wrote this tutorial to help Rails users to get started with TiDB.<\/p>\n

<\/span>Build a local TiDB development environment<\/span><\/h2>\n

Before integrating with Rails, you need to deploy a TiDB cluster on your local machine. TiDB provides a smooth deployment experience using TiUP<\/a>, a package manager for the TiDB ecosystem.<\/p>\n

Install TiUP<\/h3>\n

Installing TiUP<\/a> is pretty straightforward for either Darwin or Linux operating systems. All you need to do is a single line of command:<\/p>\n

{{< copyable “shell-regular” >}}<\/p>\n

curl --proto '=https' --tlsv1.2 -sSf https:\/\/tiup-mirrors.pingcap.com\/install.sh | sh\n<\/code><\/pre>\n
This will also add $HOME\/.tiup\/bin<\/code> in your PATH<\/code> environment variable, so you can use TiUP directly.<\/p>\n
Spin up a local cluster<\/h3>\n
As a typical TiDB cluster requires multiple nodes, deploying it might be time-consuming and complicated. Therefore, TiUP offers playground<\/code><\/a>, a TiUP component that enables you to quickly build a local TiDB test environment.<\/p>\n
The command is as simple as follows:<\/p>\n
{{< copyable “shell-regular” >}}<\/p>\n
tiup playground\n<\/code><\/pre>\n
You’ll see the output like this:<\/p>\n
tiup playground\nStarting component ``playground``: \/Users\/hooopo\/.tiup\/components\/playground\/v1.4.1\/tiup-playground\nUse the latest stable version: v5.0.0\n\n    Specify version manually: tiup playground <version>\n    The stable version: tiup playground v4.0.0\n    The nightly version: tiup playground nightly\n\nPlayground Bootstrapping...\nStart pd instance\nStart tikv instance\nStart tidb instance\nWaiting for tidb instances ready\n127.0.0.1:4000 ... Done\nStart tiflash instance\nWaiting for tiflash instances ready\n127.0.0.1:3930 ... Done\nCLUSTER START SUCCESSFULLY, Enjoy it ^-^\nTo connect TiDB: mysql --host 127.0.0.1 --port 4000 -u root -p (no password)\nTo view the dashboard: http:\/\/127.0.0.1:2379\/dashboard\nTo view the Prometheus: http:\/\/127.0.0.1:9090\nTo view the Grafana: http:\/\/127.0.0.1:3000\n<\/code><\/pre>\n
Congrats! Your local cluster is now up and running.<\/p>\n
Access TiDB Dashboard<\/h3>\n
TiDB provides TiDB Dashboard<\/a>, a Web UI for monitoring your cluster. It is already built into the PD component, so you can directly access it via http:\/\/127.0.0.1:2379\/dashboard.<\/p>\n\"TiDB\n
For more information on TiUP, see the official documentation<\/a>.<\/p>\n
<\/span>Configure Rails for TiDB<\/span><\/h2>\n
Now that you have a running TiDB cluster, the next step is to integrate it with Rails.<\/p>\n
Create a Rails project<\/h3>\n
Because TiDB is compatible with MySQL, you can create a Rails app configured for MySQL:<\/p>\n
rails new myapp --database=mysql\n<\/code><\/pre>\n
Configure database.yml<\/code><\/h3>\n
There are two configurations you need to pay attention to in database.yml<\/code>:<\/p>\n