Neo4j
借助 Neo4j 连接器,您可以对 Neo4j 数据库执行插入、删除、更新和读取操作。
准备工作
在使用 Neo4J 连接器之前,请先完成以下任务:
- 在您的 Google Cloud 项目中:
- 确保已设置网络连接。如需了解网络模式,请参阅网络连接。
- 向配置连接器的用户授予 roles/connectors.admin IAM 角色。
- 将以下 IAM 角色授予您要用其来使用连接器的服务账号:
roles/secretmanager.viewer
roles/secretmanager.secretAccessor
服务账号是一种特殊类型的 Google 账号,用于表示需要验证身份并获得授权以访问 Google API 数据的非人类用户。如果您没有服务账号,则必须创建一个服务账号。如需了解详情,请参阅创建服务账号。
- 启用以下服务:
secretmanager.googleapis.com
(Secret Manager API)connectors.googleapis.com
(Connectors API)
如需了解如何启用服务,请参阅启用服务。
如果之前没有为您的项目启用这些服务或权限,则在您配置连接器时,系统会提示您启用。
- Neo4j 5 需要 Java 17 运行时。
配置连接器
配置连接器时,您需要创建与数据源(即后端系统)的连接。一个连接需专用于一个数据源。这意味着,如果您有许多数据源,则必须为每个数据源创建单独的连接。如需创建连接,请执行以下步骤:
- 在 Cloud 控制台 中,进入 Integration Connectors > 连接页面,然后选择或创建一个 Google Cloud 项目。
- 点击 + 新建以打开创建连接页面。
- 在位置部分中,选择连接的位置。
- 区域:从下拉列表中选择一个位置。
如需查看所有受支持区域的列表,请参阅位置。
- 点击下一步。
- 区域:从下拉列表中选择一个位置。
- 在连接详情部分中,完成以下操作:
- 连接器:从可用连接器的下拉列表中选择 Neo4J。
- 连接器版本:从可用版本的下拉列表中选择一个连接器版本。
- 在连接名称字段中,输入连接实例的名称。
连接名称必须符合以下条件:
- 连接名称可以使用字母、数字或连字符。
- 字母必须小写。
- 连接名称必须以字母开头,以字母或数字结尾。
- 连接名称不能超过 49 个字符。
- (可选)输入连接实例的说明。
- 您可以选择启用 Cloud Logging,然后选择日志级别。默认情况下,日志级别设置为
Error
。 - 服务账号:选择具有所需角色的服务账号。
- (可选)配置连接节点设置:
- 节点数下限:输入连接节点数下限。
- 节点数上限:输入连接节点数上限。
节点是处理事务的连接单元(或副本)。 连接处理越多事务就需要越多节点,相反,处理越少事务需要越少节点。 如需了解节点如何影响连接器价格,请参阅连接节点的价格。如果未输入任何值,则默认情况下,节点数下限设置为 2(以便提高可用性),节点数上限设置为 50。
- 用户定义的视图:指向包含自定义视图的 JSON 配置文件的文件路径。
- 使用代理:选中此复选框可为连接配置代理服务器并配置以下值:
-
代理身份验证方案:选择要通过代理服务器进行身份验证的身份验证类型。支持以下身份验证类型:
- 基本:基本 HTTP 身份验证。
- 摘要:摘要 HTTP 身份验证。
- 代理用户:用于向代理服务器进行身份验证的用户名。
- 代理密码:用户密码的 Secret Manager 密文。
-
代理 SSL 类型:连接到代理服务器时使用的 SSL 类型。支持以下身份验证类型:
- 自动:默认设置。如果网址是 HTTPS 网址,则使用“隧道”选项。如果网址是 HTTP 网址,则使用“永不”选项。
- 始终:连接始终启用 SSL。
- 永不:连接未启用 SSL。
- 隧道:连接通过隧道代理建立。代理服务器会打开与远程主机的连接,并且流量会流经该代理。
- 在代理服务器部分中,输入代理服务器的详细信息。
- (可选)点击 + 添加标签,以键值对的形式向连接添加标签。
- 点击下一步。
- 在目标部分中,输入要连接到的远程主机(后端系统)的详细信息。
- 目标类型:选择目标类型。
- 从列表中选择主机地址,以指定目标的主机名或 IP 地址。
- 如果要与后端系统建立专用连接,请从列表中选择端点连接,然后从端点连接列表中选择所需的端点连接。
如果要与后端系统建立公共连接以提高安全性,您可以考虑为连接配置静态出站 IP 地址,然后将防火墙规则配置为仅将特定静态 IP 地址列入许可名单。
要输入其他目标,请点击 + 添加目标。
- 点击下一步。
- 目标类型:选择目标类型。
-
在身份验证部分中,输入身份验证详细信息。
- 选择身份验证类型,然后输入相关详细信息。
Neo4J 连接支持以下身份验证类型:
- 用户名和密码
- 点击下一步。
如需了解如何配置这些身份验证类型,请参阅配置身份验证。
- 选择身份验证类型,然后输入相关详细信息。
- 查看:查看您的连接和身份验证详细信息。
- 点击创建。
配置身份验证
根据您要使用的身份验证输入详细信息。
-
用户名和密码
- 用户名:连接器的用户名
- 密码:包含与连接器关联的密码的 Secret Manager Secret。
Neo4j 配置
如需为 Neo4J 配置身份验证,请执行以下操作:
- 安装 Java
- 安装 Neo4j 社区版
- 访问 Neo4j 浏览器
- 启用 HTTPS
安装 Java
- 下载 Java SE Development Kit (JDK) 11。
- 使用以下命令安装适配器:
sudo yum install https://neo4j.com/docs/operations-manual/current/installation/linux/rpm/
- 如需验证安装,请在终端中运行以下命令:
java --version
安装 Neo4j 社区版
- 使用以下命令以 root 身份安装 Neo4j:
zypper install neo4j-5.18.0
。 - 安装完成后,使用以下命令验证安装状态:
sudo service neo4j status
。 - 在首次启动数据库之前,请使用以下命令为初始用户设置密码:
bin/neo4j-admin dbms set-initial-password
。如果您未设置初始密码,系统会为 Neo4j 设置默认密码。
- 在首次登录时更改默认密码。
- 使用以下命令启动 Neo4j:
systemctl start neo4j
- 运行
systemctl status neo4j
命令,检查 Neo4j 的状态
访问 Neo4j 浏览器
- 在 Neo4j 浏览器中打开以下网址:
http://your-vm-name:7474
- 输入用户名和密码
neo4j/neo4j
。 - 点击 + 按钮,然后选择创建。
- 选择关系,然后点击创建。
- 为关系名称指定 KNOWS。
启用 HTTPS
- 打开终端并运行相应命令以生成自签名证书。
- 运行以下命令以启动启用了 HTTPS 的服务器:
sudo /opt/neo4j/bin/neo4j start --enable-browser --alsologtostderr --dbms-options=dbms.security.https_port=7473
如需了解详情,请参阅 SSL 框架。
设置主机地址
在 Neo4j 浏览器中访问以下网址:https://your-vm-name:7473
主机地址是 IP 地址和端口的组合,例如 https://{IP_ADDRESS}:7473
。端口地址取决于您要访问的具体服务。
下表列出了端口详细信息:
服务 | 默认端口 | 配置设置 | 示例 |
---|---|---|---|
Bolt 协议(适用于数据库连接) | 7687 | server.bolt.listen_address | bolt://127.0.0.1:7687 |
HTTP(适用于网页界面) | 7474 | server.http.listen_address | http://127.0.0.1:7474 |
HTTPS(安全网页界面) | 7473 | server.https.listen_address | https://127.0.0.1:7473 |
如需了解详情,请参阅端口详情。
连接配置示例
本部分列出了您在创建 Neo4J 连接时配置的各种字段的示例值。
SSL 连接类型
字段名称 | 详细信息 |
---|---|
位置 | europe-west1 |
连接器 | neo4j |
连接器版本 | 1 |
连接名称 | google-cloud-neo4j-conn |
服务账号 | SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com |
节点数下限 | 2 |
节点数上限 | 50 |
自定义受信任证书存储区 | neo4j_Private_Cert |
Secret 版本 | 1 |
目标类型 | 主机地址 |
主机 | https://192.0.2.0/td> |
端口 | PORT |
用户名 | 用户名 |
密码 | 密码 |
密钥版本 | 3 |
实体、操作和动作
所有集成连接器都会为所连接应用的对象提供抽象层。您只能通过此抽象访问应用的对象。抽象作为实体、操作和动作向您展示。
- 实体:实体可以被视为连接的应用或服务中的对象或属性集合。不同连接器的实体定义也会有所不同。例如,在数据库连接器中,表是实体;在文件服务器连接器中,文件夹是实体;在消息传递系统连接器中,队列是实体。
但可能的情况是,连接器不支持或不具有任何实体,在这种情况下,
Entities
列表将为空。 - 操作:操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作:
从可用列表中选择一个实体,系统会生成该实体可用的操作列表。如需了解操作的详细说明,请参阅连接器任务的实体操作。不过,如果连接器不支持任何实体操作,则
Operations
列表中不会列出此类不受支持的操作。 - 动作:动作是可通过连接器接口提供给集成的头等函数。动作可让您对一个或多个实体进行更改,并且动作因连接器而异。通常,操作会有一些输入参数和一个输出参数。但可能的情况是,连接器不支持任何动作,在这种情况下,
Actions
列表将为空。
系统限制
Neo4j 连接器每个节点每秒可处理 5 笔事务,并会对超出此限制的所有事务进行节流。默认情况下,集成连接器会为连接分配 2 个节点(以提高可用性)。
如需了解适用于集成连接器的限制,请参阅限制。
操作
本部分列出了该连接器支持的操作。如需了解如何配置操作,请参阅操作示例。
ExecuteCustomQuery 操作
通过此操作,您可以执行自定义查询。
如需创建自定义查询,请按照下列步骤操作:
- 按照详细说明添加连接器任务。
- 配置连接器任务时,在要执行的动作类型中选择动作。
- 在动作列表中,选择执行自定义查询,然后点击完成。
- 展开任务输入部分,然后执行以下操作:
- 在在以下时间后超时字段中,输入查询执行前要等待的秒数。
默认值:
180
秒。 - 在最大行数字段中,输入要从数据库返回的最大行数。
默认值:
25
。 - 要更新自定义查询,请点击修改自定义脚本。系统随即会打开脚本编辑器对话框。
- 在脚本编辑器对话框中,输入 SQL 查询,然后点击保存。
您可以在 SQL 语句中使用问号 (?) 表示必须在查询参数列表中指定的单个参数。例如,以下 SQL 查询会从
Employees
表中选择与为LastName
列指定的值匹配的所有行:SELECT * FROM Employees where LastName=?
- 如果您在 SQL 查询中使用了问号,则必须点击 + 添加参数名称,针对每个问号添加参数。执行集成时,这些参数按顺序替换 SQL 查询中的问号 (?)。例如,如果您添加了三个问号 (?),那么必须按顺序添加三个参数。
如需添加查询参数,请执行以下操作:
- 从类型列表中,选择参数的数据类型。
- 在值字段中,输入参数的值。
- 要添加多个参数,请点击 + 添加查询参数。
- 在在以下时间后超时字段中,输入查询执行前要等待的秒数。
成功执行后,此操作会返回状态 200(OK),并附带包含查询结果的响应正文。
操作示例
本部分介绍如何在此连接器中执行一些操作。
示例 - 创建节点
此示例展示了如何创建新节点。
- 在
Configure Connector
对话框中,选择Region, Connection, and Actions
。 - 从操作中选择
Execute Custom Query
,然后点击完成。 - 在连接器的任务输入部分,点击
Edit Custom Script
,然后在Custom Query
字段中输入类似于以下内容的值:CREATE (:Movie {title: 'Hey', release_year: 2010})
如果操作成功,Execute Custom Query
任务的 connectorOutputPayload
响应参数会提供空载荷 [ ]。
示例 - 更新节点
此示例展示了如何更新节点。
- 在
Configure Connector
对话框中,选择Region, Connection and Actions
。 - 从操作中选择
Execute Custom Query
,然后点击完成。 - 在连接器的任务输入部分,点击
Edit Custom Script
,然后在Custom Query
字段中输入类似于以下内容的值:match(m:Movie{title: 'Inception'}) set m.release_year=2011 return m
如果操作成功,Execute Custom Query
任务的 connectorOutputPayload
响应参数值类似于以下内容:
[{ "m": "{\"release_year\":2011,\"title\":\"Inception\"}" }]
示例 - 删除节点
以下示例展示了如何删除节点。
- 在
Configure Connector
对话框中,选择Region, Connection and Actions
。 - 从操作中选择
Execute Custom Query
,然后点击完成。 - 在连接器的任务输入部分,点击
Edit Custom Script
,然后在Custom Query
字段中输入类似于以下内容的值:match(m:Movie{title: 'hey'}) delete m
如果操作成功,Execute Custom Query
任务的 connectorOutputPayload
响应参数会提供空载荷 [ ]。
示例 - 创建关系
以下示例展示了如何创建关联。
- 在
Configure Connector
对话框中,选择Region, Connection and Actions
。 - 从操作中选择
Execute Custom Query
,然后点击完成。 - 在连接器的任务输入部分,点击
Edit Custom Script
,然后在Custom Query
字段中输入类似于以下内容的值:CREATE(movie:Movie {title: 'bcon'}), (actor:Actor {name: 'leo'}) CREATE(actor)-[:ACTED_IN]->(movie)
如果操作成功,Execute Custom Query
任务的 connectorOutputPayload
响应参数会提供空载荷 [ ]。
示例 - 更新关系
以下示例展示了如何更新关系。
- 在
Configure Connector
对话框中,选择Region, Connection and Actions
。 - 从操作中选择
Execute Custom Query
,然后点击完成。 - 在连接器的任务输入部分,点击
Edit Custom Script
,然后在Custom Query
字段中输入类似于以下内容的值:match(movie:Movie {title: 'demo'}), (actor:Actor {name: 'first'}) match(actor)-[r:ACTED_IN]->(movie) set actor.name='second',r.year=2024 return actor,r,movie
如果操作成功,Execute Custom Query
任务的 connectorOutputPayload
响应参数值类似于以下内容:
[{ "actor": "{\"name\":\"second\"}", "r": "{\"year\":2024}", "movie": "{\"title\":\"demo\"}" }]
示例 - 删除关系
以下示例展示了如何删除关系。
- 在
Configure Connector
对话框中,选择Region, Connection and Actions
。 - 从操作中选择
Execute Custom Query
,然后点击完成。 - 在连接器的任务输入部分,点击
Edit Custom Script
,然后在Custom Query
字段中输入类似于以下内容的值:MATCH(movie:Movie {title: 'bcon44'}), (actor:Actor {name: 'jacky'}) MATCH(actor)-[r:ACTED_IN]->(movie) delete r
如果操作成功,Execute Custom Query
任务的 connectorOutputPayload
响应参数会提供空载荷 [ ]。
示例 - 更新节点标签
此示例展示了如何更新节点标签。
- 在
Configure Connector
对话框中,选择Region, Connection and Actions
。 - 从操作中选择
Execute Custom Query
,然后点击完成。 - 在连接器的任务输入部分,点击
Edit Custom Script
,然后在Custom Query
字段中输入类似于以下内容的值:MATCH (n:Person) where id(n)=18 set n:Actor RETURN n
如果操作成功,Execute Custom Query
任务的 connectorOutputPayload
响应参数值类似于以下内容:
[{ "n": "{\"born\":1962,\"name\":\"Demi Moore\"}" }]
示例 - 更新关系类型
以下示例展示了如何更新关系类型。
- 在
Configure Connector
对话框中,选择Region, Connection and Actions
。 - 从操作中选择
Execute Custom Query
,然后点击完成。 - 在连接器的任务输入部分,点击
Edit Custom Script
,然后在Custom Query
字段中输入类似于以下内容的值:MATCH (n:Person) where id(n)=18 set n.born=1963 RETURN n
如果操作成功,Execute Custom Query
任务的 connectorOutputPayload
响应参数值类似于以下内容:
[{ "n": "{\"born\":1963,\"name\":\"Demi Moore\"}" }]
示例 - 创建数据类型
此示例展示了如何创建数据类型。
- 在
Configure Connector
对话框中,选择Region, Connection and Actions
。 - 从操作中选择
Execute Custom Query
,然后点击完成。 - 在连接器的任务输入部分,点击
Edit Custom Script
,然后在Custom Query
字段中输入类似于以下内容的值:CREATE (:Product {unitPrice: 109.50, unitsInStock: 390, supplierID: "1", productID: "dumy-2", discontinued: false, quantityPerUnit: "10 boxes x 20 bags", productName: "productName-1", unitsOnOrder: 0, reorderLevel: 10, supplier: ["1"], expiry: Duration("P14DT18H12M"), categoryID: "1", updatedAt: DateTime("1984-11-11T12:31:14Z")})
如果操作成功,Execute Custom Query
任务的 connectorOutputPayload
响应参数会提供空载荷 [ ]。
示例 - 更新数据类型
此示例展示了如何更新数据类型。
- 在
Configure Connector
对话框中,选择Region, Connection and Actions
。 - 从操作中选择
Execute Custom Query
,然后点击完成。 - 在连接器的任务输入部分,点击
Edit Custom Script
,然后在Custom Query
字段中输入类似于以下内容的值:match(p:Product{productID: "dumy-1"}) set p.duration = Duration("P15DT19H12M"), p.updatedAt=DateTime("1984-11-12T12:31:14Z") return p
如果操作成功,Execute Custom Query
任务的 connectorOutputPayload
响应参数值类似于以下内容:
[{ "p": "{\"unitPrice\":109.5, \"unitsInStock\":390, \"supplierID\":\"1\", \"productID\":\"dumy-1\", \"discontinued\":false, \"quantityPerUnit\":\"10 boxes x 20 bags\", \"productName\":\"productName-1\", \"unitsOnOrder\":0, \"duration\":\"P15DT19H12M\", \"reorderLevel\":10, \"supplier\":[\"1\"], \"expiry\":\"P14DT18H12M\", \"categoryID\":\"1\", \"updatedAt\":\"1984-11-12T12:31:14Z\"}" }, { "p":"{\"unitPrice\":109.5, \"unitsInStock\":390, \"supplierID\":\"1\", \"productID\":\"dumy-1\", \"discontinued\":false, \"quantityPerUnit\":\"10 boxes x 20 bags\", \"productName\":\"productName-1\", \"unitsOnOrder\":0, \"duration\":\"P15DT19H12M\", \"reorderLevel\":10, \"supplier\":[\"1\"], \"expiry\":\"P14DT18H12M\", \"categoryID\":\"1\", \"updatedAt\":\"1984-11-12T12:31:14Z\"}" }]
示例 - 删除数据类型
以下示例展示了如何删除数据类型。
- 在
Configure Connector
对话框中,选择Region, Connection and Actions
。 - 从操作中选择
Execute Custom Query
,然后点击完成。 - 在连接器的任务输入部分,点击
Edit Custom Script
,然后在Custom Query
字段中输入类似于以下内容的值:match(p:Product{productID: "dumy-2"}) delete p
以下示例展示了如何删除数据类型。
如果操作成功,Execute Custom Query
任务的 connectorOutputPayload
响应参数会提供空载荷 [ ]。
示例 - 获取节点数
以下示例展示了如何获取节点数量。
- 在
Configure Connector
对话框中,选择Region, Connection and Actions
。 - 从操作中选择
Execute Custom Query
,然后点击完成。 - 在连接器的任务输入部分,点击
Edit Custom Script
,然后在Custom Query
字段中输入类似于以下内容的值:MATCH () RETURN count(*) AS numNodes
如果操作成功,Execute Custom Query
任务的 connectorOutputPayload
响应参数会提供类似于以下内容的载荷:
[{ "numNodes": 6267.0 }]
实体操作示例
本部分介绍如何在此连接器中执行一些实体操作。
示例 - 列出所有语言
以下示例展示了如何列出所有语言。
- 在
Configure connector task
对话框中,点击Entities
。 - 从
Entity
列表中选择 multilanguage_table。 - 选择
List
操作,然后点击完成。 - 在数据映射器部分中,点击打开数据映射编辑器,然后根据需要设置 filterClause。
示例 - 获取语言
以下示例展示了如何获取语言。
- 在
Configure connector task
对话框中,点击Entities
。 - 从
Entity
列表中选择 multilanguage_table。 - 选择
Get
操作,然后点击完成。 - 将实体 ID 设置为“获取单个语言”。如需设置实体 ID,请在数据映射器部分中,点击打开数据映射编辑器,然后在输入值字段中输入
58.0
,并选择 entityId 作为本地变量。
使用 Terraform 创建连接
您可以使用 Terraform 资源创建新的连接。如需了解如何应用或移除 Terraform 配置,请参阅基本 Terraform 命令。
如需查看用于创建连接的 Terraform 模板示例,请参阅模板示例。
使用 Terraform 创建此连接时,您必须在 Terraform 配置文件中设置以下变量:
参数名称 | 数据类型 | 必需 | 说明 |
---|---|---|---|
proxy_enabled | BOOLEAN | False | 选中此复选框可为连接配置代理服务器。 |
proxy_auth_scheme | ENUM | False | 用于向 ProxyServer 代理进行身份验证的身份验证类型。支持的值包括:BASIC、DIGEST、NONE |
proxy_user | STRING | False | 用于向 ProxyServer 代理进行身份验证的用户名。 |
proxy_password | SECRET | False | 用于向 ProxyServer 代理进行身份验证的密码。 |
proxy_ssltype | ENUM | False | 连接到 ProxyServer 代理时使用的 SSL 类型。支持的值包括:AUTO、ALWAYS、NEVER、TUNNEL |
user_defined_views | STRING | False | 指向包含自定义视图的 JSON 配置文件的文件路径。 |
在集成中使用 Neo4J 连接
创建连接后,该连接将在 Apigee Integration 和 Application Integration 中可用。您可以通过连接器任务在集成中使用该连接。
- 如需了解如何在 Apigee Integration 中创建和使用连接器任务,请参阅连接器任务。
- 如需了解如何在 Application Integration 中创建和使用连接器任务,请参阅连接器任务。