PRISMA快速入门之Typescript

本文属使用Prisma构建GraphQL服务系列。

本文介绍如何使用typescript开发prisma服务。将使用graphql-yoga作为web服务器,并使用prisma-binding连接Prisma数据库服务。

本文代码可从GitHub上的GraphQL样板项目中找到。

先安装node和Docker吧,骚年

安装CLI

本教程使用Prisma CLI管理Prisma数据库服务,第一步先安装CLI工具。
打开终端,全局安装Prisma CLI:

# 1
npm install -g prisma

确保已安装了Docker,再继续.
初始化本地环境,后续可将Prisma服务部署在本地,

## 2
prisma local start

说明:这行命令从Docker下载两个镜像文件,比较大,耐心等待。

构建GraphQL服务

现在可以使用prisma init命令构建GraphQL 服务。注意,这条命令将触发选择模版的交互式会话。

prisma init命令my-app参数,Prisma CLI将创建my-app目录,此目录下存放项目所有文件。

## 3
prisma init my-app
  • 当提示how you want to set up your Prisma service?时,选择GraphQL server/fullstack boilerplate(recommended)选项。
  • 接着CLI提示选择GraphQL 样板(select a GraphQL boilerplate as foundation for your project)作为基础时,选择typescript-basic样板。
  • 最终,提示何处部署(which cluster you want to deploy)时,选择localcluster。

注意,此处的cluster与Docker中的集群还是有点差别,但可以如此理解。

prisma init命令执行完成后,Prisma 数据库服务部署完成,可以通过 http://localhost:4466/my-app/dev访问。

如你所知,数据库服务的HTTP端点由以下组件组成:

  • cluster的域(指~/.prisma/config.yml文件中的host属性):http://localhost:4466/my-app/dev;
  • Prisma service名字,在prisma.yml文件中指定:my-app;
  • 服务部署stage,默认为:dev

注意,此端点在src/index.ts中引用,实例化Prisma,并绑定application schema与Prisma schema:

const server = new GraphQLServer({
  typeDefs: './src/schema.graphql',                 // points to the application schema
  resolvers,
  context: req => ({
    ...req,
    db: new Prisma({
      endpoint: 'http://localhost:4466/my-app/dev', // the endpoint of the Prisma DB service
      secret: 'mysecret123',                        // specified in `database/prisma.yml`
      debug: true,                                  // log all GraphQL queries & mutations
    }),
  }),
})

文件结构如下:


1.1.1structure.png

了解以下:

最重要的两个文件database/datamodel.graphqlsrc/schema.graphql

  • database/datamodel.graphql:定义数据模型;
  • src/schema.graphql:定义向客户端公开的API。

典型的database/datamodel.graphql`数据模型如下:

type Post {
  id: ID! @unique
  isPublished: Boolean!
  title: String!
  text: String!
}

基于此数据模型,Prisma生成Prisma schema,即GraphQL schema,定义了CRUD API,此schema保存在src/generated/prisma.graphql中,并由CLI在部署时更新。
现在可以启动服务了....

第三步:启动服务

调用package.json中定义的devscript,其将启动服务,且打开一个GraphQL Playground程序。

## 4
cd my-app
yarn dev

注意,Playground可同时使用两个API:

  • app:application schema,即公开的Web服务GraphQL API(在src/schema.graphql定义)
  • database:Prisma schema,即Prisma数据库服务提供的GraphQL CRUD API(在database/datamodel.graphql定义)。

可以简单理解为:app为对外公开的服务API,供客户端调用;database为数据库,供自己使用,对客户端不可见。

1.1.1playground.png

注意,Playground自动生成文档,显示所有支持的GraphQL API操作(如查询query、突变mutation和订阅subscription),如上图右边所示.

一旦Playground打开,可以发送查询和突变。

针对appliction schema发送查询和突变

使用 appPlayground访问application schema中定义的GraphQL API。

粘贴如下代码到左侧面板中appPlayground,点击Play-button(CMD+Enter):

mutation {
  createDraft(
    title: "GraphQL is awesome!",
    text: "It really is."
  ) {
    id
  }
}

如果此时发送feedQuery,服务仍然返回空数组,因为feed仅仅返回PostisPublished属性true的数据(createDraft突变创建的数据isPublishedfalse),可以通过publish突变先发布一个Post

复制调用createDraft返回Postid,替换如下代码中__POST_ID__占位符:

mutation {
  publish(id: "__POST_ID__") {
    id
    isPublished
  }
}

执行上面突变后,有一条数据isPublishedtrue了,即可调用feedQuery,返回已经发布了的Post

query {
  feed {
    id
    title
    text
  }
}

这与访问传统REST API有点像:在数据库之上封装了一层向外公开的API。

针对Prisma API发送查询和突变

Prisma scheme(src/generated/prisma.graphql)定义GraphQL CRUD API,使用database Playground访问。

现在直接针对数据库API,所以不受application scheme逻辑限制,可以使用完整的CRUD功能发布Post

粘贴如下代码到左侧面板中database Playground,点击Play-button(CMD+Enter):

mutation {
  createPost(
    data: {
      title: "What I love most about GraphQL",
      text: "That it is declarative.",
      isPublished: true
    }
  ) {
    id
  }
}

通过mutation创建Post数据,其isPublished字段为true,所以可用feed query返回。

database Playground,当然也可以针对现有的Post直接发送updatedelete mutation,依照规则,必须先获取其id值。

database Playground发送如下查询:

{
  posts {
    id
    title
  }
}

从返回的数组中任意取一个id值,替换如下代码中的__POST_ID__占位符:

mutation {
  updatePost(
    where: { id: "__POST_ID__" },
    data: { text: "The awesome community." }
  ) {
    id
    title
    text
  }
}

将对应idtext属性修改为The awesome community.

最后,删除Post,发送如下mutation(再次使用上面的id替换__POST_ID__占位符):

mutation {
  deletePost(
    where: { id: "__POST_ID__" }
  ) {
    id
    title
    text
  }
}

这与用SQL直接访问数据库有点像,供系统内部使用

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,311评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,339评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,671评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,252评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,253评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,031评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,340评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,973评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,466评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,937评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,039评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,701评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,254评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,259评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,485评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,497评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,786评论 2 345

推荐阅读更多精彩内容