npm 包 gvnn-postgraphql 使用教程

什么是 gvnn-postgraphql？

gvnn-postgraphql 是一个 npm 包，它允许你将你的 Postgres 数据库通过 GraphQL API 进行访问。gvnn-postgraphql 提供了一种快速、灵活的方法来查询和修改数据库中的数据。此外，gvnn-postgraphql 还可以自动处理表之间的关系，使得你可以方便地查询到关联的数据。

安装 gvnn-postgraphql

安装 gvnn-postgraphql 很简单，只需在终端中运行以下命令：

npm install -g gvnn-postgraphql

请注意，gvnn-postgraphql 需要全局安装。

使用 gvnn-postgraphql

使用 gvnn-postgraphql 的第一步是创建配置文件。gvnn-postgraphql 使用 .json 文件来配置数据库连接和生成的 GraphQL API。以下是一个简单的配置文件示例：

{
    "postgres": "postgres://user:pass@localhost/mydb",
    "schema": "public"
}

以上配置文件中的 "postgres" 字段指定了数据库连接字符串。可以在其中指定数据库的地址、用户名、密码和数据库名称。如果你的数据库位于本地主机上并且使用默认端口，则仅需要指定用户名和密码即可。以下是一个示例连接字符串：

postgres://user:pass@localhost/mydb

"schema" 字段指定了要在 GraphQL 中包含的架构的名称。在本例中，我们将所有公共表添加到 GraphQL API 中。

接下来，打开终端并运行以下命令：

gvnn-postgraphql config.json --watch

该命令将从指定的配置文件中读取配置，并在 localhost:5000 上启动 GraphQL API。该 API 可以通过浏览器访问，也可以通过使用 GraphQL 客户端进行查询。

查询数据

现在你已经设置了 GraphQL API，你可以使用 GraphQL 来查询数据库中的数据。以下是一个简单的查询示例：

query {
    allTweets {
        nodes {
            id
            text
        }
    }
}

上述查询将返回数据库中所有 Tweets 的 id 和 text 字段。"allTweets" 字段是一个特殊的查询字段，它将返回所有 Tweets 的列表。

修改数据

你可以使用 GraphQL API 修改数据库中的数据。以下是一个示例：

mutation createTweet($text: String!) {
    createTweet(input: {tweet: {text: $text}}) {
        tweet {
            id
            text
        }
    }
}

在提交上述修改时，GraphQL 将在数据库中创建一个新的 Tweet，并返回该 Tweet 的 id 和 text 字段。

结论

gvnn-postgraphql 是一种非常有用的工具，它可以帮助你轻松地将你的 Postgres 数据库转换为 GraphQL API。在本文中，我介绍了如何安装和使用 gvnn-postgraphql，并通过示例代码演示了如何查询和修改数据库中的数据。现在，赶快试试看吧！

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055feb81e8991b448dda8d