# Prisma HTTP Server

import { Tabs, TabsContent, TabsList, TabsTrigger } from "zudoku/ui/Tabs"

{/* vale off */}
{/* THIS FILE WAS AUTOGENERATED FROM THE PUBLIC EXAMPLE REPOSITORY. DO NOT EDIT THIS FILE DIRECTLY. */}


This app comes from [Prisma's REST API Example](https://github.com/prisma/prisma-examples/tree/latest/javascript/rest-express) and shows how to create a **REST API** using [Express](https://expressjs.com/) and [Prisma Client](https://www.prisma.io/docs/concepts/components/prisma-client) and deploy it onto Unikraft Cloud.
It uses a SQLite database file with some initial [migration data](./prisma/migrations/20240208151224_init/).

To run this example, follow these steps:

1. Install the CLI.
   Use the [unikraft CLI](/cli/unikraft) or the legacy [kraft CLI](https://unikraft.org/docs/cli/install).
   You need a [BuildKit](https://github.com/moby/buildkit) builder. The easiest way to get one is via [Docker](https://docs.docker.com/engine/install/).
   Alternatively, you can also directly set up and use BuildKit, see the [quick start](https://github.com/moby/buildkit#quick-start).

:::note
The unikraft CLI is the current standard, while kraft is the legacy version.
Choose one of the CLIs below and only run the commands associated with it for the rest of this guide.
:::

2. Clone the [`examples` repository](https://github.com/unikraft-cloud/examples) and `cd` into the `examples/httpserver-prisma-expressjs4.19-node18/` directory:

```bash
git clone https://github.com/unikraft-cloud/examples
cd examples/httpserver-prisma-expressjs4.19-node18/
```

Make sure to log into Unikraft Cloud and pick a [metro](/platform/metros) close to you.
This guide uses `fra` (Frankfurt, 🇩🇪):

<CodeTabs syncKey="cli">

```bash title="unikraft"
unikraft login
```

```bash title="kraft"
# Set Unikraft Cloud access token
export UKC_TOKEN=token
# Set metro to Frankfurt, DE
export UKC_METRO=fra
```

</CodeTabs>

When done, invoke the following command to deploy this app on Unikraft Cloud:

<CodeTabs syncKey="cli">

```bash title="unikraft"
unikraft build . --output <my-org>/httpserver-prisma-expressjs419-node18:latest
unikraft run --scale-to-zero policy=on,cooldown-time=1000 --metro fra -p 443:3000/tls+http -m 512M --image <my-org>/httpserver-prisma-expressjs419-node18:latest
```

```bash title="kraft"
kraft cloud deploy --scale-to-zero on --scale-to-zero-cooldown 1s -p 443:3000/tls+http -M 512Mi .
```

</CodeTabs>

The output shows the instance address and other details:

<CodeTabs syncKey="cli">

```ansi title="unikraft"
metro:        fra
name:         httpserver-prisma-expressjs419-node18-hdof1
uuid:         066f55cb-bcbd-45e5-9f6b-b3866c3a3a4c
state:        starting
image:        <my-org>/httpserver-prisma-expressjs419-node18
resources:
  memory:     512MiB
  vcpus:      1
service:
  uuid:       b7da8a3b-ca4d-979a-3ae9-9634bca98008
  name:       funky-sun-4bf8v7g9
  domains:
  - fqdn:     funky-sun-4bf8v7g9.fra.unikraft.app
networks:
- uuid:       63d977e8-548c-f0af-cc97-39856660f612
  private-ip: 10.0.28.2
  mac:        12:b0:43:fb:5c:30
timestamps:
  created:    just now
```

```ansi title="kraft"
[●] Deployed successfully!
 │
 ├───────── name: httpserver-prisma-expressjs419-node18-hdof1
 ├───────── uuid: 066f55cb-bcbd-45e5-9f6b-b3866c3a3a4c
 ├──────── metro: https://api.fra.unikraft.cloud/v1
 ├──────── state: starting
 ├─────── domain: https://funky-sun-4bf8v7g9.fra.unikraft.app
 ├──────── image: oci://unikraft.io/<my-org>/httpserver-prisma-expressjs419-node18@sha256:770d4af1d490daea11171c680eaf99e2a6017a262ba9fbf1ba8d708f5fc32bfe
 ├─────── memory: 512 MiB
 ├────── service: funky-sun-4bf8v7g9
 ├─ private fqdn: httpserver-prisma-expressjs419-node18-hdof1.internal
 └─── private ip: 10.0.28.2
```

</CodeTabs>

In this case, the instance name is `httpserver-prisma-expressjs419-node18-hdof1` and the address is `https://funky-sun-4bf8v7g9.fra.unikraft.app`.
They're different for each run.

Use `curl` to test the REST API, such as the `/users` endpoint:

```bash
curl https://funky-sun-4bf8v7g9.fra.unikraft.app/users
```

```json
[{"id":1,"email":"alice@prisma.io","name":"Alice"},
 {"id":2,"email":"nilu@prisma.io","name":"Nilu"},
 {"id":3,"email":"mahmoud@prisma.io","name":"Mahmoud"}]
```

You can list information about the instance by running:

<CodeTabs syncKey="cli">

```bash title="unikraft"
unikraft instances list
```

```bash title="kraft"
kraft cloud instance list
```

</CodeTabs>

<CodeTabs syncKey="cli">

```ansi title="unikraft"
METRO  NAME                                         STATE    IMAGE                                           ARGS  MEMORY  VCPUS  FQDN                                 CREATED
fra    httpserver-prisma-expressjs419-node18-hdof1  running  <my-org>/httpserver-prisma-expressjs419-node18        512MiB  1      funky-sun-4bf8v7g9.fra.unikraft.app  2 minutes ago
```

```ansi title="kraft"
NAME                                         FQDN                                 STATE    STATUS        IMAGE                                                                        MEMORY   VCPUS  ARGS  BOOT TIME
httpserver-prisma-expressjs419-node18-hdof1  funky-sun-4bf8v7g9.fra.unikraft.app  running  1 minute ago  oci://unikraft.io/<my-org>/httpserver-prisma-expressjs419-node18@sha256:...  512 MiB  1            37.94 ms
```

</CodeTabs>

When done, you can remove the instance:

<CodeTabs syncKey="cli">

```bash title="unikraft"
unikraft instances delete httpserver-prisma-expressjs419-node18-hdof1
```

```bash title="kraft"
kraft cloud instance remove httpserver-prisma-expressjs419-node18-hdof1
```

</CodeTabs>

## Using the app

You can access the REST API of the server using the following endpoints:

### Endpoints

- `GET /post/:id`: Fetch a single post by its `id`
- `GET /feed?searchString={searchString}&take={take}&skip={skip}&orderBy={orderBy}`: Fetch all _published_ posts
  - Query Parameters
    - `searchString` (optional): This filters posts by `title` or `content`
    - `take` (optional): This specifies how many objects the list should return
    - `skip` (optional): This specifies how many of the returned objects in the list to skip
    - `orderBy` (optional): The sort order for posts in either ascending or descending order. The value can either `asc` or `desc`
- `GET /user/:id/drafts`: Fetch user's drafts by their `id`
- `GET /users`: Fetch all users
- `POST /post`: Create a new post
  - Body:
    - `title: String` (required): The title of the post
    - `content: String` (optional): The content of the post
    - `authorEmail: String` (required): The email of the user that creates the post
- `POST /signup`: Create a new user
  - Body:
    - `email: String` (required): The email address of the user
    - `name: String` (optional): The name of the user
    - `postData: PostCreateInput[]` (optional): The posts of the user
- `PUT /publish/:id`: Toggle the publish value of a post by its `id`
- `PUT /post/:id/views`: Increases the `viewCount` of a `Post` by one `id`
- `DELETE /post/:id`: Delete a post by its `id`

## Evolving the app

Evolving the app typically requires two steps:

1. Migrate your database using Prisma Migrate
1. Update your app code

For the following example scenario, assume you want to add a "profile" feature to the app where users can create a profile and write a short bio about themselves.

### 1. Migrate your database using Prisma Migrate

The first step is to add a new table, for example called `Profile`, to the database.
You can do this by adding a new model to your [Prisma schema file](./prisma/schema.prisma) file and then running a migration afterward:

```diff
// ./prisma/schema.prisma

model User {
  id      Int      @default(autoincrement()) @id
  name    String?
  email   String   @unique
  posts   Post[]
+ profile Profile?
}

model Post {
  id        Int      @id @default(autoincrement())
  createdAt DateTime @default(now())
  updatedAt DateTime @updatedAt
  title     String
  content   String?
  published Boolean  @default(false)
  viewCount Int      @default(0)
  author    User?    @relation(fields: [authorId], references: [id])
  authorId  Int?
}

+model Profile {
+  id     Int     @default(autoincrement()) @id
+  bio    String?
+  user   User    @relation(fields: [userId], references: [id])
+  userId Int     @unique
+}
```

Once you've updated your data model, you can execute the changes against your database with the following command:

```console
npx prisma migrate dev --name add-profile
```

This adds another migration to the `prisma/migrations` directory and creates the new `Profile` table in the database.

### 2. Update your app code

You can now use your `PrismaClient` instance to perform operations against the new `Profile` table.
Those operations can create API endpoints in the REST API.

#### 2.1 Add the app programming interface endpoint to your app

Update your `src/index.js` file by adding a new endpoint to your API:

```js
app.post('/user/:id/profile', async (req, res) => {
  const { id } = req.params
  const { bio } = req.body

  const profile = await prisma.profile.create({
    data: {
      bio,
      user: {
        connect: {
          id: Number(id)
        }
      }
    }
  })

  res.send(profile)
})
```

#### 2.2 Testing out your new endpoint

Restart your app server and test out your new endpoint.

##### Create endpoint

- `/user/:id/profile`: Create a new profile based on the user id
  - Body:
    - `bio: String` : The bio of the user

Here are some more sample Prisma Client queries on the new Profile model:

##### Create a new profile for an existing user

```ts
const profile = await prisma.profile.create({
  data: {
    bio: 'Hello World',
    user: {
      connect: { email: 'alice@prisma.io' },
    },
  },
})
```

##### Create a new user with a new profile

```ts
const user = await prisma.user.create({
  data: {
    email: 'john@prisma.io',
    name: 'John',
    profile: {
      create: {
        bio: 'Hello World',
      },
    },
  },
})
```

##### Update the profile of an existing user

```ts
const userWithUpdatedProfile = await prisma.user.update({
  where: { email: 'alice@prisma.io' },
  data: {
    profile: {
      update: {
        bio: 'Hello Friends',
      },
    },
  },
})
```

## Switch to another database

If you want to try this example with another database than SQLite, you can adjust the database connection in [`prisma/schema.prisma`](./prisma/schema.prisma) by reconfiguring the `datasource` block.

Learn more about the different connection configurations in the [docs](https://www.prisma.io/docs/reference/database-reference/connection-urls).

### PostgreSQL

For PostgreSQL, the connection address has the following structure:

```prisma
datasource db {
  provider = "postgresql"
  url      = "postgresql://USER:PASSWORD@HOST:PORT/DATABASE?schema=SCHEMA"
}
```

Here is an example connection string with a local PostgreSQL database:

```prisma
datasource db {
  provider = "postgresql"
  url      = "postgresql://janedoe:mypassword@localhost:5432/notesapi?schema=public"
}
```

### MySQL

For MySQL, the connection address has the following structure:

```prisma
datasource db {
  provider = "mysql"
  url      = "mysql://USER:PASSWORD@HOST:PORT/DATABASE"
}
```

Here is an example connection string with a local MySQL database:

```prisma
datasource db {
  provider = "mysql"
  url      = "mysql://janedoe:mypassword@localhost:3306/notesapi"
}
```

### Microsoft structured query language server database

Here is an example connection string with a local Microsoft SQL Server database:

```prisma
datasource db {
  provider = "sqlserver"
  url      = "sqlserver://localhost:1433;initial catalog=sample;user=sa;password=mypassword;"
}
```

### MongoDB

Here is an example connection string with a local MongoDB database:

```prisma
datasource db {
  provider = "mongodb"
  url      = "mongodb://USERNAME:PASSWORD@HOST/DATABASE?authSource=admin&retryWrites=true&w=majority"
}
```

## Learn more

Use the `--help` option for detailed information on using Unikraft Cloud:

<CodeTabs syncKey="cli">

```bash title="unikraft"
unikraft --help
```

```bash title="kraft"
kraft cloud --help
```

</CodeTabs>

Or visit the [CLI Reference](/cli/unikraft) or the [legacy CLI Reference](/cli/kraft/overview).
{/* vale on */}