{"id":18248163,"url":"https://github.com/serverless-components/tencent-postgresql","last_synced_at":"2025-04-04T15:32:12.679Z","repository":{"id":54505234,"uuid":"226265892","full_name":"serverless-components/tencent-postgresql","owner":"serverless-components","description":"Tencent Cloud Postgres DB component.","archived":false,"fork":false,"pushed_at":"2021-10-22T13:52:39.000Z","size":105,"stargazers_count":19,"open_issues_count":0,"forks_count":2,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-03-20T15:01:45.405Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/serverless-components.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-12-06T06:56:48.000Z","updated_at":"2022-04-30T14:33:44.000Z","dependencies_parsed_at":"2022-08-13T18:01:06.198Z","dependency_job_id":null,"html_url":"https://github.com/serverless-components/tencent-postgresql","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverless-components%2Ftencent-postgresql","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverless-components%2Ftencent-postgresql/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverless-components%2Ftencent-postgresql/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverless-components%2Ftencent-postgresql/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/serverless-components","download_url":"https://codeload.github.com/serverless-components/tencent-postgresql/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247203030,"owners_count":20900899,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-05T09:36:06.845Z","updated_at":"2025-04-04T15:32:07.672Z","avatar_url":"https://github.com/serverless-components.png","language":"JavaScript","readme":"# 腾讯云 PostgreSQL DB 组件\n\n## 简介\n\n腾讯云 PostgreSQL DB 组件通过使用 [Serverless Framework](https://github.com/serverless/components)，基于云上 Serverless 服务，实现“0”配置，便捷开发，可以快速方便的创建，部署和管理腾讯云的 PostgreSQL 产品。\n\n特性介绍：\n\n- [x] **按需付费** - 按照请求的使用量进行收费，没有请求时无需付费。\n- [x] **\"0\"配置** - 默认配置将由 Serverless 完成。\n- [x] **极速部署** - 仅需几秒，创建或更新您的数据库。\n- [x] **便捷协作** - 通过云端数据库的状态信息和部署日志，方便的进行多人协作开发。\n\n\u003cbr/\u003e\n\n## 快速开始\n\n1. [安装](#1-安装)\n2. [创建](#2-创建)\n3. [配置](#3-配置)\n4. [账号配置](#4-账号配置)\n5. [部署](#5-部署)\n6. [查看状态](#6-查看状态)\n7. [移除](#7-移除)\n\n### 1. 安装\n\n通过 npm 全局安装 最新版本的 Serverless Framework\n\n```shell\n$ npm install -g serverless\n```\n\n### 2. 创建\n\n创建并进入一个全新目录：\n\n```\n$ mkdir tencent-postgresql \u0026\u0026 cd tencent-postgresql\n```\n\n### 3. 配置\n\n在新目录下创建 `serverless.yml` 文件，在其中进行如下配置\n\n```shell\n$ touch serverless.yml\n```\n\n```yml\n# serverless.yml\ncomponent: postgresql #(必填) 引用 component 的名称，当前用到的是 postgresql 组件\nname: serverlessDB # (必填) 该 postgresql 组件创建的实例名称\norg: test # (可选) 用于记录组织信息，默认值为您的腾讯云账户 appid\napp: serverlessDB # (可选) 该 sql 应用名称\nstage: dev # (可选) 用于区分环境信息，默认值是 dev\n\ninputs:\n  region: ap-guangzhou # 可选 ap-guangzhou, ap-shanghai, ap-beijing\n  zone: ap-guangzhou-2 # 可选 ap-guangzhou-2, ap-shanghai-2, ap-beijing-3\n  dBInstanceName: serverlessDB\n  vpcConfig:\n    vpcId: vpc-id3zoj6r\n    subnetId: subnet-kwc49rti\n  extranetAccess: false\n```\n\nPostgreSQL 组件支持 0 配置部署，也就是可以直接通过配置文件中的默认值进行部署。但你依然可以修改更多可选配置来进一步开发该项目。\n\n- [更多配置](https://github.com/serverless-tencent/tencent-postgresql/tree/master/docs/configure.md)\n\n\u003e 注：当前 PGSQL for Serverless 仅支持 `北京三区，广州二区，上海二区` 三个地域的创建和部署，因此在填写 yaml 中的地域可用区时需要注意填写为正确的地域和对应的 VPC 子网信息。\n\n### 4. 账号配置\n\nPostgreSQL 组件当前暂不支持 CLI 扫描二维码登录，因此您需要本地创建 `.env` 文件来配置持久的环境变量/秘钥信息，\n\n```bash\n$ touch .env # 腾讯云的配置信息\n```\n\n在 `.env` 文件中配置腾讯云的 SecretId 和 SecretKey 信息并保存\n\n如果没有腾讯云账号，可以在此 [注册新账号](https://cloud.tencent.com/register)。\n\n如果已有腾讯云账号，可以在 [API 密钥管理](https://console.cloud.tencent.com/cam/capi) 中获取 `SecretId` 和`SecretKey`.\n\n```text\n# .env\nTENCENT_SECRET_ID=123\nTENCENT_SECRET_KEY=123\n```\n\n### 5. 部署\n\n通过 `sls` 命令进行部署，并可以添加 `--debug` 参数查看部署过程中的信息\n\n```bash\n$ sls deploy\n```\n\n\u003e 注意: `sls` 是 `serverless` 命令的简写。\n\u003e 如您的账号未 [登录](https://cloud.tencent.com/login) 或 [注册](https://cloud.tencent.com/register) 腾讯云，您需要在本地创建.env 文件储存账户信息，详情请看[账号配置](#4-账号配置)。\n\n### 6. 查看状态\n\n在`serverless.yml`文件所在的目录下，通过如下命令查看部署状态：\n\n```\n$ sls info\n```\n\n### 7. 移除\n\n通过以下命令移除部署的 DB 实例，移除后该组件会对应删除云上部署时所创建的所有相关资源。\n\n```bash\n$ sls remove\n```\n\n和部署类似，支持通过 `sls remove --debug` 命令查看移除过程中的实时日志信息，`sls`是 `serverless` 命令的缩写。\n\n### 更多组件\n\n可以在 [Serverless Components](https://github.com/serverless/components) repo 中查询更多组件的信息。\n\n## License\n\nMIT License\n\nCopyright (c) 2020 Tencent Cloud, Inc.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserverless-components%2Ftencent-postgresql","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fserverless-components%2Ftencent-postgresql","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserverless-components%2Ftencent-postgresql/lists"}