feat: Add prisma sample for javascript (#73)

Co-authored-by: He Wang <[email protected]>

.github/workflows/basic-workflow.yml

@@ -47,7 +47,7 @@ jobs:
         if: ${{ inputs.language == 'python' }}
         uses: actions/setup-python@v4
         with:
-          python-version: "3.9"
+          python-version: '3.9'
       - name: Setup Ruby env
         if: ${{ inputs.language == 'ruby' }}
         uses: ruby/setup-ruby@v1

.github/workflows/javascript.yml

@@ -17,11 +17,18 @@ jobs:
         module:
           - name: 'mysql2'
             with_oceanbase_container: true
+
+          - name: 'prisma'
+            with_oceanbase_container: true
+            oceanbase_image_tag: '4.2.2'
+
           - name: 'typeorm'
             with_oceanbase_container: true
+
           - name: 'drizzle'
             with_oceanbase_container: true
             oceanbase_image_tag: '4.2.3_BETA'
+
     uses: ./.github/workflows/basic-workflow.yml
     with:
       language: 'javascript'

javascript/prisma/.env

@@ -0,0 +1 @@
+DATABASE_URL="mysql://root:@127.0.0.1:2881/test?prefer_socket=false&a=.psdb.cloud"

javascript/prisma/README-CN.md

@@ -0,0 +1,114 @@
+# Prisma 连接 OceanBase 指南
+
+[English](README.md) | 简体中文
+
+本文介绍如何通过 [Prisma](https://www.prisma.io) 连接 [OceanBase](https://www.oceanbase.com) 数据库。
+
+## 准备工作
+
+确保 Nodejs 和 npm 已经安装。
+
+## 项目配置
+
+拉取项目并进入相应目录:
+
+```bash
+git clone [email protected]:oceanbase/ob-samples.git
+cd javascript/prisma
+```
+
+全局配置环境变量 (原因详见 https://open.oceanbase.com/blog/15137753618):
+
+```bash
+export PRISMA_ENGINES_MIRROR=https://oceanbase-prisma-builds.s3.ap-southeast-1.amazonaws.com
+export BINARY_DOWNLOAD_VERSION=96fa66f2f130d66795d9f79dd431c678a9c7104e
+```
+
+安装依赖 (注意 `prisma` 和 `@prisma/client` 版本在 `^5.20.0` 及以上):
+
+```bash
+npm install
+```
+
+修改 `.env` 中的数据库连接串，格式如下。注意需要设置 `prefer_socket=false`，以避免和 OceanBase 建立连接时报错。
+
+```bash
+DATABASE_URL="mysql://root:@127.0.0.1:2881/test?prefer_socket=false&a=.psdb.cloud"
+```
+
+执行以下命令，将 `prisma/schema.prisma` 中定义的 `User`、`Post` 和 `Profile` 模型同步到数据库中:
+
+```bash
+npx prisma migrate dev --name init
+```
+
+```sql
+mysql> show tables;
++--------------------+
+| Tables_in_test     |
++--------------------+
+| _prisma_migrations |
+| posts              |
+| profiles           |
+| users              |
++--------------------+
+4 rows in set (0.02 sec)
+```
+
+执行 `index.ts`:
+
+```bash
+npx ts-node index.ts
+```
+
+输出以下内容，说明执行成功:
+
+```bash
+[
+  {
+    id: 1,
+    email: '[email protected]',
+    name: 'Alice',
+    posts: [
+      {
+        id: 1,
+        createdAt: 2024-10-31T04:33:45.535Z,
+        updatedAt: 2024-10-31T04:33:45.535Z,
+        title: 'Hello World',
+        content: null,
+        published: false,
+        authorId: 1
+      }
+    ],
+    profile: { id: 1, bio: 'I like turtles', userId: 1 }
+  }
+]
+```
+
+查看对应的 `users`、`posts` 和 `profiles` 表，数据已正常插入:
+
+```bash
+mysql> select * from users;
++----+---------------------+-------+
+| id | email               | name  |
++----+---------------------+-------+
+|  1 | [email protected] | Alice |
++----+---------------------+-------+
+1 row in set (0.01 sec)
+
+mysql> select * from posts;
++----+-------------------------+-------------------------+-------------+---------+-----------+----------+
+| id | createdAt               | updatedAt               | title       | content | published | authorId |
++----+-------------------------+-------------------------+-------------+---------+-----------+----------+
+|  1 | 2024-10-31 04:33:45.535 | 2024-10-31 04:33:45.535 | Hello World | NULL    |         0 |        1 |
++----+-------------------------+-------------------------+-------------+---------+-----------+----------+
+1 row in set (0.01 sec)
+
+mysql> select * from profiles;
++----+----------------+--------+
+| id | bio            | userId |
++----+----------------+--------+
+|  1 | I like turtles |      1 |
++----+----------------+--------+
+1 row in set (0.01 sec)
+```

javascript/prisma/README.md

@@ -0,0 +1,114 @@
+# Connect to OceanBase with Prisma
+
+English | [简体中文](README-CN.md)
+
+This document describes how to connect to [OceanBase](https://www.oceanbase.com) with [Prisma](https://www.prisma.io).
+
+## Preparation
+
+Make sure `Node.js` and `npm` are installed.
+
+## Configuration
+
+Clone the project and navigate to the appropriate directory:
+
+```bash
+git clone [email protected]:oceanbase/ob-samples.git
+cd javascript/prisma
+```
+
+Set the global environment variables (for reasons see https://open.oceanbase.com/blog/15137753618):
+
+```bash
+export PRISMA_ENGINES_MIRROR=https://oceanbase-prisma-builds.s3.ap-southeast-1.amazonaws.com
+export BINARY_DOWNLOAD_VERSION=96fa66f2f130d66795d9f79dd431c678a9c7104e
+```
+
+Install dependencies (note that the versions of `prisma` and `@prisma/client` should be `^5.20.0` or higher):
+
+```bash
+npm install
+```
+
+Modify the connection string in the `.env` file, formatted as follows. Note that `prefer_socket=false` must be set to avoid errors when connecting to OceanBase.
+
+```bash
+DATABASE_URL="mysql://root:@127.0.0.1:2881/test?prefer_socket=false&a=.psdb.cloud"
+```
+
+Execute the following command to synchronize the `User`, `Post` and `Profile` data models defined in `prisma/schema.prisma` to the database:
+
+```bash
+npx prisma migrate dev --name init
+```
+
+```sql
+mysql> show tables;
++--------------------+
+| Tables_in_test     |
++--------------------+
+| _prisma_migrations |
+| posts              |
+| profiles           |
+| users              |
++--------------------+
+4 rows in set (0.02 sec)
+```
+
+Execute `index.ts`:
+
+```bash
+npx ts-node index.ts
+```
+
+The output should be as follows, indicating successful execution:
+
+```bash
+[
+  {
+    id: 1,
+    email: '[email protected]',
+    name: 'Alice',
+    posts: [
+      {
+        id: 1,
+        createdAt: 2024-10-31T04:33:45.535Z,
+        updatedAt: 2024-10-31T04:33:45.535Z,
+        title: 'Hello World',
+        content: null,
+        published: false,
+        authorId: 1
+      }
+    ],
+    profile: { id: 1, bio: 'I like turtles', userId: 1 }
+  }
+]
+```
+
+Check the corresponding `users`, `posts` and `profiles` tables and the data has been inserted:
+
+```bash
+mysql> select * from users;
++----+---------------------+-------+
+| id | email               | name  |
++----+---------------------+-------+
+|  1 | [email protected] | Alice |
++----+---------------------+-------+
+1 row in set (0.01 sec)
+
+mysql> select * from posts;
++----+-------------------------+-------------------------+-------------+---------+-----------+----------+
+| id | createdAt               | updatedAt               | title       | content | published | authorId |
++----+-------------------------+-------------------------+-------------+---------+-----------+----------+
+|  1 | 2024-10-31 04:33:45.535 | 2024-10-31 04:33:45.535 | Hello World | NULL    |         0 |        1 |
++----+-------------------------+-------------------------+-------------+---------+-----------+----------+
+1 row in set (0.01 sec)
+
+mysql> select * from profiles;
++----+----------------+--------+
+| id | bio            | userId |
++----+----------------+--------+
+|  1 | I like turtles |      1 |
++----+----------------+--------+
+1 row in set (0.01 sec)
+```

javascript/prisma/index.ts

@@ -0,0 +1,36 @@
+import { PrismaClient } from "@prisma/client";
+
+const prisma = new PrismaClient();
+
+async function main() {
+  await prisma.user.create({
+    data: {
+      name: "Alice",
+      email: "[email protected]",
+      posts: {
+        create: { title: "Hello World" },
+      },
+      profile: {
+        create: { bio: "I like turtles" },
+      },
+    },
+  });
+
+  const allUsers = await prisma.user.findMany({
+    include: {
+      posts: true,
+      profile: true,
+    },
+  });
+  console.dir(allUsers, { depth: null });
+}
+
+main()
+  .then(async () => {
+    await prisma.$disconnect();
+  })
+  .catch(async (e) => {
+    console.error(e);
+    await prisma.$disconnect();
+    process.exit(1);
+  });

javascript/prisma/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "prisma",
+  "version": "1.0.0",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "description": "",
+  "devDependencies": {
+    "@types/node": "^22.8.4",
+    "prisma": "^5.21.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.6.3"
+  },
+  "dependencies": {
+    "@prisma/client": "^5.21.1"
+  }
+}

javascript/prisma/prisma/schema.prisma

@@ -0,0 +1,43 @@
+// This is your Prisma schema file,
+// learn more about it in the docs: https://pris.ly/d/prisma-schema
+
+generator client {
+  provider = "prisma-client-js"
+}
+
+datasource db {
+  provider = "mysql"
+  url      = env("DATABASE_URL")
+}
+
+model Post {
+  id        Int      @id @default(autoincrement())
+  createdAt DateTime @default(now())
+  updatedAt DateTime @updatedAt
+  title     String   @db.VarChar(255)
+  content   String?
+  published Boolean  @default(false)
+  author    User     @relation(fields: [authorId], references: [id])
+  authorId  Int
+
+  @@map("posts")
+}
+
+model Profile {
+  id     Int     @id @default(autoincrement())
+  bio    String?
+  user   User    @relation(fields: [userId], references: [id])
+  userId Int     @unique
+
+  @@map("profiles")
+}
+
+model User {
+  id      Int      @id @default(autoincrement())
+  email   String   @unique
+  name    String?
+  posts   Post[]
+  profile Profile?
+
+  @@map("users")
+}

javascript/prisma/run.sh

@@ -0,0 +1,5 @@
+export PRISMA_ENGINES_MIRROR=https://oceanbase-prisma-builds.s3.ap-southeast-1.amazonaws.com
+export BINARY_DOWNLOAD_VERSION=96fa66f2f130d66795d9f79dd431c678a9c7104e
+npm install
+npx prisma migrate dev --name init
+npx ts-node index.ts