Prisma官方中文文档

cnpm install -g prisma

yarn global add prisma

# PRISMA
# 
# GraphQL Database Gateway (https://www.prisma.io)
# 
# Usage: prisma COMMAND
# 
# Service:
#   init            Initialize a new service
#   deploy          Deploy service changes (or new service)
#   introspect      Introspect database schema(s) of service
#   info            Display service information (endpoints, cluster, ...)
#   token           Create a new service token
#   list            List all deployed services
#   delete          Delete an existing service
# 
# Data workflows:
#   playground      Open service endpoints in GraphQL Playground
#   seed            Seed a service with data specified in the prisma.yml
#   import          Import data into a service
#   export          Export service data to local file
#   reset           Reset the stage data
# 
# Cloud:
#   login           Login or signup to the Prisma Cloud
#   logout          Logout from Prisma Cloud
#   console         Open Prisma Console in browser
#   account         Display account information
# 
# Use prisma help [command] for more information about a command.
# Docs can be found here: https://bit.ly/prisma-cli-commands
# 
# Examples:
# 
# - Initialize files for a new Prisma service
#   prisma init
# 
# - Deploy service changes (or new service)
#   prisma deploy

prisma init hello-world
# 按part1示例
cd hello-world
prisma deploy
prisma playground

projects:
  prisma:
    schemaPath: prisma.graphql
    extensions:
      prisma: prisma.yml

npm install -g proxy
DEBUG="*" proxy -p 8080
HTTP_PROXY=http://localhost:8080 HTTPS_PROXY=https://localhost:8080 prisma deploy

-e, --endpoint         The endpoint to be written into prisma.yml

prisma init DIRNAME

prisma init myapp

prisma init myapp --endpoint http://localhost:4466/myapp/dev

prisma deploy [flags]

-d，--dry                 干跑执行部署 -e，--env-file ENV-FILE   注入ENV的.ENV文件路径 -f，--force               强制deploy，接受由数据更改造成的数据丢失 -j，--json                JSON输出 -n，--new                 强制交互模式来选择集群 -w，--watch               监视更改 --no-seed                 禁止种子数据导入 `}

prisma deploy

prisma deploy --new

prisma deploy --env-file .env.prod

prisma generate [flags]

-e, --env-file ENV-FILE    Path to .env file to inject env vars `}

generate:
    - generator: typescript-client
      output: ./generated/prisma

prisma generate

generate:
    - generator: go-client
      output: ./generated/prisma
    - generator: graphql-schema
      output: ./generated/prisma

prisma generate

prisma introspect

prisma introspect

#  ? What kind of database do you want to introspect? Postgres
#  ? Enter database host localhost
#  ? Enter database port 5432
#  ? Enter database user prisma
#  ? Enter database password ****
#  ? Enter name of existing database prisma-db
#  ? Enter name of existing schema public
#  
#  Introspecting database 402ms
#  Created datamodel mapping based on 7 database tables.
#  
#  Created 1 new file:               
#  
#    datamodel-[TIMESTAMP].graphql    GraphQL SDL-based datamodel (derived from existing database)

prisma info

 -e, --env-file ENV-FILE    Path to .env file to inject env vars
 -j, --json                 JSON Output
 -s, --secret               Print secret in JSON output (requires --json option)

prisma info

prisma info --json

prisma info --json --secret

prisma token [flags]

-c, --copy                 Copy token to clipboard
-e, --env-file ENV-FILE    Path to .env file to inject env vars

prisma token

prisma token --copy

prisma list

prisma list

prisma delete [flags]

 -e, --env-file ENV-FILE    Path to .env file to inject env vars
 -f, --force                Force delete, without confirmation

prisma delete

prisma delete --force

prisma playground [flags]

--dotenv DOTENV          Path to .env file to inject env vars
-w, --web                Open browser-based Playground

prisma playground

prisma playground --web

prisma seed [flags]

-e, --env-file ENV-FILE    Path to .env file to inject env vars
-r, --reset                Reset the service before seeding

prisma seed

prisma seed --reset

prisma import [flags]

-d, --data PATH            (required) Path to zip or directory with import data (NDF)
-e, --env-file ENV-FILE    Path to .env file to inject env vars

prisma export [flags]

-e, --env-file ENV-FILE    Path to .env file to inject env vars
-p, --path PATH            Path to export .zip file

prisma export

prisma export --path mydata.zip

prisma reset

 -e, --env-file ENV-FILE    Path to .env file to inject env vars
 -f, --force                Force reset data without confirmation

prisma reset

prisma reset --force

prisma login [flags]

-k, --key KEY    Cloud session key

prisma login

prisma login --key KEY

prisma logout

prisma logout

prisma console

prisma console

prisma account

prisma account

datamodel: datamodel.prisma

datamodel: datamodel.prisma
endpoint: http://localhost:4466/myservice/dev
secret: mysecret42
generate:
    - generator: javascript-client
      output: ./generated/prisma
hooks:
  post-deploy:
    - prisma generate

#该服务是基于这两个文件类型定义
#databasetypes.graphql和database/enums.graphql
datamodel:
  - database/types.graphql
  - database/enums.graphql
#endpoint代表了你的Prisma API的HTTP endpoint。
#它表示了几条信息:
#-*Prisma服务器('localhost:4466'在这个例子中)
#-*服务名称('myservice'在这个例子中)
#-*阶段('dev'在这个例子中)
#注:服务名称和阶段被设置为'default'时，他们可被省略。
#http://myserver.com/default/default可以写成http://myserver.com。
endpoint: http://localhost:4466/myservice/dev
#密码用于创建JSON Web Token(JWTs)。这些令牌需要在Prisma的endpoint发出的HTTP请求加上'Authorization'头。
#警告:如果不提供密码，在Prisma API可以无需验证访问!
secret: mysecret123
#生成一个JavaScript Prisma client并储存在output指定的目录
generate:
    - generator: javascript-client
      output: ./generated/prisma
#在部署时执行命令生成Prisma client
hooks:
  post-deploy:
    - prisma generate
#这个服务有一个事件Subscriptions配置。相应的Subscriptions查询位于'database/subscriptions/welcomeEmail.graphql'。
#当Subscriptions被触发，指定'webhook'经由HTTP调用。
subscriptions:
  sendWelcomeEmail:
    query: database/subscriptions/sendWelcomeEmail.graphql
    webhook:
      url: https://${self:custom.serverlessEndpoint}/sendWelcomeEmail
      headers:
        Authorization: ${env:MY_ENDPOINT_SECRET}
#初次部署时会用该文件中的数据导入种子数据
seed:
  import: database/seed.graphql
#此服务只定义了一个自定义变量，是'subscription'的'webhook'引用地址
custom:
  serverlessEndpoint: https://bcdeaxokbj.execute-api.eu-west-1.amazonaws.com/dev

.
│ .graphqlconfig
├── prisma.yml
└── database
    ├── subscriptions
    │   └── welcomeEmail.graphql
    ├── types.graphql
    └── enums.graphql

yamlKeyXYZ: ${variableSource}

subscriptions:
  sendWelcomeEmail:
    query: database/subscriptions/sendWelcomeEmail.graphql
    webhook:
      url: https://${self:custom.serverlessEndpoint}/sendWelcomeEmail
custom:
  serverlessEndpoint: example.org

subscriptions:
  sendWelcomeEmail:
    query: database/subscriptions/sendWelcomeEmail.graphql
    webhook:
      url: https://example.org/sendWelcomeEmail
      headers:
        Authorization: ${env:MY_TOKEN}

datamodel: types.graphql

datamodel:
  - types.graphql
  - enums.graphql

endpoint: http://localhost:4466/default/default

终点:https://eu1.prisma.sh/jane-doe/myservice/dev

endpoint: http://my-pr-Publi-1GXX8QUZU3T89-413349553.us-east-1.elb.amazonaws.com/cat-pictures/prod

secret: moo4ahn3ahb4phein1eingaep

secret: myFirstSecret,    SECRET_NUMBER_2,3rd-secret

secret: ${env:MY_SECRET}

generate:
    - generator: javascript-client
      output: ./generated/prisma
    - generator: graphql-schema
      output: ./generated/prisma

hooks:
  post-deploy:
    - echo "Deployment finished"
    - graphql get-schema --project db
    - graphql codegen

projects:
  db:
    schemaPath: generated/prisma.graphql
    extensions:
      prisma: prisma.yml
      codegen:
        - generator: prisma-binding
          language: typescript
          output:
            binding: src/generated/prisma.ts

subscriptions:
  sendWelcomeEmail:
    query: database/subscriptions/sendWelcomeEmail.graphql
    webhook: https://bcdeaxokbj.execute-api.eu-west-1.amazonaws.com/dev/sendWelcomeEmail

subscriptions:
  sendWelcomeEmail:
    query: database/subscriptions/sendWelcomeEmail.graphql
    webhook:
      url: https://bcdeaxokbj.execute-api.eu-west-1.amazonaws.com/dev/sendWelcomeEmail
      headers:
        Authorization: ${env:MY_SECRET}
        Content-Type: application/json

seed:
  import: database/seed.graphql

seed:
  import: database/backup.zip

seed:
  run: node script.js

custom:
  serverlessEndpoint: https://bcdeaxokbj.execute-api.eu-west-1.amazonaws.com/dev
  subscriptionQueries: database/subscriptions/
subscriptions:
  sendWelcomeEmail:
    query: ${self:custom.subscriptionQueries}/sendWelcomeEmail.graphql
    webhook: https://${self:custom.serverlessEndpoint}/sendWelcomeEmail

+--------------+                    +----------------+                       +------------+
| +--------------+                  |                |                       |            |
| |            | |                  |                |                       |            |
| | SQL        | |  (1) transform   |      NDF       |  (2) chunked upload   |   Prisma   |
| | MongoDB    | | +--------------> |                | +-------------------> |            |
| | JSON       | |                  |                |                       |            |
| |            | |                  |                |                       |            |
+--------------+ |                  +----------------+                       +------------+
  +--------------+

.
├── data
│   ├── lists
│   │   ├── 0001.json
│   │   ├── 0002.json
│   │   └── 0003.json
│   ├── nodes
│   │   ├── 0001.json
│   │   └── 0002.json
│   └── relations
│       └── 0001.json
├── datamodel.prisma
└── prisma.yml

prisma import --data data

curl 'http://localhost:4466/my-app/dev/import' -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJPbmxpbmUgSldUIEJ1aWxkZXIiLCJpYXQiOjE1MTM1OTQzMTEsImV4cCI6MTU0NTEzMDMxMSwiYXVkIjasd3d3LmV4YW1wbGUuY29tIiwic3ViIjoianJvY2tldEBleGFtcGxlLmNvbSIsIkdpdmVuTmFtZSI6IkpvaG5ueSIsIlN1cm5hbWUiOiJSb2NrZXQiLCJFbWFpbCI6Impyb2NrZXRAZXhhbXBsZS5jb20iLCJSb2xlIjpbIk1hbmFnZXIiLCJQcm9qZWN0IEFkbWluaXN0cmF0b3IiXX0.L7DwH7vIfTSmuwfxBI82D64DlgoLBLXOwR5iMjZ_7nI' -d '{"valueType":"nodes","values":[{"_typeName":"Model0","id":"0","a":"test","b":0,"createdAt":"2017-11-29 14:35:13"},{"_typeName":"Model1","id":"1","a":"test","b":1},{"_typeName":"Model2","id":"2","a":"test","b":2,"createdAt":"2017-11-29 14:35:13"},{"_typeName":"Model0","id":"3","a":"test","b":3},{"_typeName":"Model3","id":"4","a":"test","b":4,"createdAt":"2017-11-29 14:35:13","updatedAt":"2017-11-29 14:35:13"},{"_typeName":"Model3","id":"5","a":"test","b":5},{"_typeName":"Model3","id":"6","a":"test","b":6},{"_typeName":"Model4","id":"7"},{"_typeName":"Model4","id":"8","string":"test","int":4,"boolean":true,"dateTime":"1015-11-29 14:35:13","float":13.333,"createdAt":"2017-11-29 14:35:13","updatedAt":"2017-11-29 14:35:13"},{"_typeName":"Model5","id":"9","string":"test","int":4,"boolean":true,"dateTime":"1015-11-29 14:35:13","float":13.333,"createdAt":"2017-11-29 14:35:13","updatedAt":"2017-11-29 14:35:13"}]}' -sSv

curl '__SERVICE_ENDPOINT__/import' -H 'Content-Type: application/json' -H 'Authorization: Bearer __JWT_AUTH_TOKEN__' -d '{"valueType":"__NDF_TYPE__","values": __DATA__ }' -sSv

{
  "fileType": "nodes",
  "cursor": {
    "table": 0,
    "row": 0,
    "field": 0,
    "array": 0
  }
}

curl 'http://localhost:4466/my-app/dev/export' -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJPbmxpbmUgSldUIEJ1aWxkZXIiLCJpYXQiOjE1MTM1OTQzMTEsImV4cCI6MTU0NTEzMDMxMSwiYXVkIjasd3d3LmV4YW1wbGUuY29tIiwic3ViIjoianJvY2tldEBleGFtcGxlLmNvbSIsIkdpdmVuTmFtZSI6IkpvaG5ueSIsIlN1cm5hbWUiOiJSb2NrZXQiLCJFbWFpbCI6Impyb2NrZXRAZXhhbXBsZS5jb20iLCJSb2xlIjpbIk1hbmFnZXIiLCJQcm9qZWN0IEFkbWluaXN0cmF0b3IiXX0.L7DwH7vIfTSmuwfxBI82D64DlgoLBLXOwR5iMjZ_7nI' -d '{"fileType":"nodes","cursor":{"table":0,"row":0,"field":0,"array":0}}' -sSv

curl '__SERVICE_ENDPOINT__/export' -H 'Content-Type: application/json' -H 'Authorization: Bearer __JWT_AUTH_TOKEN__' -d '{"fileType":"__NDF_TYPE__","cursor": {"table":__TABLE__,"row":__ROW__,"field":__FIELD__,"array":__ARRAY__}} }' -sSv

type User {
  id: String! @unique
  firstName: String!
  lastName: String!
  hobbies: [String!]! @scalarList(strategy: RELATION)
  partner: User
}

{
  "valueType": "nodes",
  "values": [
    { "_typeName": STRING, "id": STRING, "<scalarField1>": ANY, "<scalarField2>": ANY, ..., "<scalarFieldN>": ANY },
    ...
  ]
}

{
  "valueType": "nodes",
  "values": [
    {"_typeName": "User", "id": "johndoe", "firstName": "John", "lastName": "Doe"},
    {"_typeName": "User", "id": "sarahdoe", "firstName": "Sarah", "lastName": "Doe"}
  ]
}

{
  "valueType": "lists",
  "values": [
    { "_typeName": STRING, "id": STRING, "<scalarListField>": [ANY] },
    ...
  ]
}

{
  "valueType": "lists",
  "values": [
    {"_typeName": "User", "id": "johndoe", "hobbies": ["Fishing", "Cooking"]},
    {"_typeName": "User", "id": "sarahdoe", "hobbies": ["Biking", "Coding"]}
  ]
}

{
  "valueType": "relations",
  "values": [
    [
      { "_typeName": STRING, "id": STRING, "fieldName": STRING },
      { "_typeName": STRING, "id": STRING, "fieldName": STRING }
    ],
    ...
  ]
}

{
  "valueType": "relations",
  "values": [
    [
      { "_typeName": "User", "id": "johndoe", "fieldName": "partner" },
      { "_typeName": "User", "id": "sarahdoe", "fieldName": "partner" }
    ]
  ]
}