neo4j图数据库配置及使用说明

1.配置

config文件夹下增加配置文件neo4j_conf.xml。内容如下:

<?xml version="1.0" encoding="UTF-8"?>
<!--milvus向量数据库配置文件-->
<conf>
    <!--类型-->
    <pm name="dbtype">neo4j</pm>
    <!--url-->
    <pm name="dburl"><![CDATA[neo4j://ip:port]]></pm>
    <!--用户名-->
    <pm name="dbuser">user</pm>
    <!--密码-->
    <pm name="dbpassword">pwd</pm>
    <!--数据库名称-->
    <pm name="dbName">neo4j</pm>
    <!--最大连接数-->
    <pm name="maxTotal">10</pm>
    <!--最大空闲连接数-->
    <pm name="maxIdle">5</pm>
    <!--最小空闲连接数-->
    <pm name="minIdle">1</pm>
    <!--从连接池获取连接的最大等待时间(毫秒)-->
    <pm name="maxWaitMillis">5000</pm>
    <!--连接在池中最小空闲时间(毫秒)-->
    <pm name="minEvictableIdleTimeMillis">60000</pm>
    <!--测试连接有效性-->
    <pm name="testOnBorrow">true</pm>
    <!--归还连接时测试-->
    <pm name="testOnReturn">false</pm>
    <!--空闲时测试连接-->
    <pm name="testWhileIdle">true</pm>
    <!--每次检查连接的数量-->
    <pm name="numTestsPerEvictionRun">3</pm>
    <!--空闲连接检查间隔(毫秒)-->
    <pm name="timeBetweenEvictionRunsMillis">30000</pm>
</conf>

2.调用方式

在使用microbee-http框架的前提下,进行实例化 DataActionsWrapperMilvus。

    例:DataActionsWrapperNeo4j neo4j = DataActionsWrapperNeo4j.getInstance();

实例化之后进行调用方法

    neo4j.createLabel("标签名称");

3.方法说明

方法名描述
 createLabel创建标签(带属性/不带属性)
 createNode创建节点(支持单条及多条)
 labelExists验证标签是否存在
 queryNodes查询节点
 updateNode更新节点
 deleteNode删除节点
 getNodeById根据节点id查询节点信息
 relationTypeExists验证关系是否存在
 createRelation创建关系
 queryRelations查询关系
 updateRelation更新关系
 deleteRelation删除关系
 getRelationById根据关系id查询关系信息
 getAllRelationTypes获取所有关系名称
 getRelationGraphById根据关系id获取关系图
 getRelationFrapByName根据关系名称获取关系图
 getNodesByLabel根据标签名称获取标签下所有节点
 executeCypher执行cypher语句

4.调用参数及返回值说明

4.1.创建标签(不带属性:没有默认节点)

方法名 createLabel
参数 String labelName
参数说明 labelName:标签名称
返回值{
  "msg": "标签创建成功",
  "code": 0
}
返回值说明code:成功或失败(0:成功;其他失败)
msg:提示语
调用示例Map<String, Object> label1 = instance.createLabel("框架测试1");

 

4.2.创建标签(带属性:有默认节点)

方法名 createLabel
参数String labelName
Map<String, Object> properties
参数说明labelName:标签名称
properties:标签属性
返回值{
  "msg": "标签创建成功",
  "code": 0
}
返回值说明code:成功或失败(0:成功;其他失败)
msg:提示语
调用示例Map<String, Object> param = new HashMap<>();
param.put("id",1);
param.put("time","2026-04-01 10:18:00");
Map<String, Object> label2 = instance.createLabel("框架测试2", param);

 

4.3.根据标签名称创建节点(支持单条及多条)

方法名createNode
参数String label
String propertiesJson
参数说明label:节点名称
propertiesJson:节点属性json集合
  注:多条需为[{},{},…]格式,单条需为{}格式
返回值{
    "code": 0,
    "label": "权金龙测试3",
    "msg": "节点创建成功",
    "nodeId": 88,
    "properties": {
        "id": "十六点三十一分"
    }
}
返回值说明code:是否成功(0:成功;3:失败)
msg:提示语
lable:所属标签
nodeId:节点id
properties:节点信息
调用示例Map<String, Object> param = new HashMap<>();
param.put("id",1);
param.put("time","2026-04-01 10:18:00");
Map<String, Object> node1 = instance.createNode("框架测试1", JSON.toJSONString(param));

 

4.4.验证标签是否存在

方法名labelExists
参数String name
参数说明name:标签名称
返回值boolean
返回值说明true:存在
false:不存在
调用示例boolean b = instance.labelExists("权金龙测试3");

 

4.5.查询节点

方法名queryNodes
参数String label
String whereClause
Map<String, Object> params
参数说明label:标签名称
whereClause:条件
  例:a.id>10 
params:参数
  注:若条件中使用占位符,该map存对应值,否则传null
返回值[
  {
    "id": 1024,
    "labels": ["Person"],
    "properties": {
      "name": "张三",
      "age": 25
    }
  },
  {
    "id": 1025,
    "labels": ["Person"],
    "properties": {
      "name": "李四",
      "age": 30
    }
  }
]
返回值说明id:节点id
labels:所属标签
properties:节点属性
调用示例List<Map<String, Object>> mapList = instance.queryNodes("开发测试3", null, null);

 

4.6.更新节点

方法名updateNode
参数long nodeId
Map<String, Object> properties
参数说明nodeId:节点id
properties:节点属性
返回值{
    "code": 0,
    "msg": "节点更新成功",
    "nodeId": 88,
    "properties": {
        "id": "十六点三十一分"
    }
}
返回值说明code:成功或失败(0:成功;1:节点未找到;3:失败)
msg:提示语
nodeId:节点id
properties:节点属性
调用示例Map<String, Object> param1 = new HashMap<>();
param1.put("id",1);
Map<String, Object> stringObjectMap1 = instance.updateNode(82, param1);

 

4.7.删除节点

方法名deleteNode
参数long nodeId
参数说明nodeId:节点id
返回值{
    "code": 0,
    "msg": "节点删除成功"
}
返回值说明code:成功或失败(0:成功; 3:失败)
msg:提示语
调用示例Map<String, Object> stringObjectMap2 = instance.deleteNode(82);

 

4.8.根据节点id查询节点信息

方法名getNodeById
参数long nodeId
参数说明nodeId:节点id
返回值{
    "code": 0,
    "label": "权金龙测试3",
    "msg": "节点查询成功",
    "id": 88,
    "properties": {
        "id": "十六点三十一分"
    }
}
返回值说明code:是否成功(0:成功;2:节点未找到;3:失败)
msg:提示语
lable:所属标签
id:节点id
properties:节点信息
调用示例Map<String, Object> nodeById = instance.getNodeById(82);

 

4.9.验证关系是否存在

方法名relationTypeExists
参数String relationTypeName
参数说明relationTypeName:关系名称
返回值boolean
返回值说明true:存在
false:不存在
调用示例boolean b1 = instance.relationTypeExists("TEST_TO");

 

4.10.创建节点之间的关系

方法名createRelation
参数long fromNodeId
long toNodeId
String relationType
Map<String, Object> properties
参数说明fromNodeId:起始节点id
toNodeId:结束节点id
relationType:关系名称
properties:关系属性
返回值{
    "code": 0,
    "type": "TEST_TO",
    "msg": "关系创建成功",
    "relationId": 102,
    "properties": {
        "id": "十六点三十一分"
    }
}
返回值说明code:是否成功(0:成功;2:节点未找到;3:失败)
msg:提示语
type:关系名称
relationId:关系id
properties:关系属性
调用示例Map<String, Object> relation = instance.createRelation(289, 290, "框架", null);

 

4.11.查询关系

方法名queryRelations
参数String relationType
String whereClause
Map<String, Object> params
参数说明relationType:关系名称
whereClause:条件
  例:a.id>10 
params:参数
  注:若条件中使用占位符,该map存对应值,否则传null
返回值[
  {
    "id": 99,
"type": "TEST_TO",
    "startNodeId": 82,
    "endNodeId": 85,
    "properties": {
      "name": "张三",
      "age": 25
    }
  }
]
返回值说明id:关系id
type:关系名称
startNodeId:起始节点id
endNodeId:结束节点id
properties:节点属性
调用示例List<Map<String, Object>> mapList = instance.queryRelations("TEST_TO", null, null);

 

4.12.更新关系

方法名updateRelation
参数long relationId
Map<String, Object> properties
参数说明relationId:关系id
properties:节点属性
返回值{
    "code": 0,
    "msg": "关系更新成功",
    "relationId": 88,
    "properties": {
        "id": "十六点三十一分"
    }
}
返回值说明code:成功或失败(0:成功;1:节点未找到;3:失败)
msg:提示语
relationId:关系id
properties:关系属性
调用示例Map<String, Object> param = new HashMap<>();
param.put("name","测试修改关系属性");
Map<String, Object> stringObjectMap = instance.updateRelation(259, param);

 

4.13.删除关系

方法名deleteRelation
参数long relationId
参数说明relationId:关系id
返回值{
    "code": 0,
    "msg": "关系删除成功"
}
返回值说明code:成功或失败(0:成功; 3:失败)
msg:提示语
调用示例Map<String, Object> deleteRelation = instance.deleteRelation(259);

 

4.14.根据关系id查询关系信息

方法名getRelationById
参数long relationId
参数说明relationId:关系id
返回值[
  {
    "code": 0,
    "msg": "关系查询成功",
    "id": 20,
    "type": "TETS_TO",
    "properties": {
      "id": 200,
      "name": "aaa"
    },
    "startNodeId": 20,
    "endNodeId": 21
  },
  {
    "code": 0,
    "msg": "关系查询成功",
    "id": 21,
    "type": "TETS_TO",
    "properties": {
      "id": 200,
      "name": "aaa"
    },
    "startNodeId": 22,
    "endNodeId": 21
  }
]
返回值说明code:成功或失败(0:成功;2:关系未找到)
msg:提示语
id:关系id
type:关系名称
properties:关系属性
startNodeId:起始节点id
endNodeId:结束节点id
调用示例Map<String, Object> relationById = instance.getRelationById(25);

 

4.15.获取所有关系名称

方法名getAllRelationTypes
参数无
参数说明无
返回值[
  "属于",
  "开发",
  "实现",
  "测试",
  "创建"
]
返回值说明List<String> 关系名称集合
调用示例List<String> allRelationTypes = instance.getAllRelationTypes();

 

4.16.根据关系id获取关系图

方法名getRelationGraphById
参数long relationId
参数说明relationId:关系id
返回值[
    {
        "startNode": {
            "id": 85,
            "properties": {
                "name": "张三",
                "id": "测试1"
            },
            "labels": [
                "权金龙测试4"
            ]
        },
        "endNode": {
            "id": 87,
            "properties": {
                "name": "测试一下",
                "id": "十四点五十七分"
            },
            "labels": [
                "权金龙测试3"
            ]
        },
        "relation": {
            "id": 87,
            "type": "TEST_TO",
            "properties": {
                "ooo": "wawawawawa",
                "since": "16:59"
            }
        }
    },
    {
        "startNode": {
            "id": 87,
            "properties": {
                "name": "测试一下",
                "id": "十四点五十七分"
            },
            "labels": [
                "权金龙测试3"
            ]
        },
        "endNode": {
            "id": 86,
            "properties": {
                "id": "十四点五十四分"
            },
            "labels": [
                "权金龙测试3"
            ]
        },
        "relation": {
            "id": 88,
            "type": "TEST_TO",
            "properties": {}
        }
    }
]
返回值说明startNode:开始节点信息
    id:节点内部id
    properties:节点详细信息
    labels:所属标签
endNode:结束节点信息
    id:节点内部id
    properties:节点详细信息
    labels:所属标签
relation:关系信息
    id:关系id
    type:关系名称
    properties:关系属性
调用示例Map<String, Object> relationGraphById = instance.getRelationGraphById(259);

 

4.17.根据关系名称获取关系图

方法名getRelationGraphByName
参数String relationName
Integer limit
参数说明relationName:关系名称
limit:查询条数
返回值[
    {
        "startNode": {
            "id": 85,
            "properties": {
                "name": "张三",
                "id": "测试1"
            },
            "labels": [
                "权金龙测试4"
            ]
        },
        "endNode": {
            "id": 87,
            "properties": {
                "name": "测试一下",
                "id": "十四点五十七分"
            },
            "labels": [
                "权金龙测试3"
            ]
        },
        "relation": {
            "id": 87,
            "type": "TEST_TO",
            "properties": {
                "ooo": "wawawawawa",
                "since": "16:59"
            }
        }
    },
    {
        "startNode": {
            "id": 87,
            "properties": {
                "name": "测试一下",
                "id": "十四点五十七分"
            },
            "labels": [
                "权金龙测试3"
            ]
        },
        "endNode": {
            "id": 86,
            "properties": {
                "id": "十四点五十四分"
            },
            "labels": [
                "权金龙测试3"
            ]
        },
        "relation": {
            "id": 88,
            "type": "TEST_TO",
            "properties": {}
        }
    }
]
返回值说明startNode:开始节点信息
    id:节点内部id
    properties:节点详细信息
    labels:所属标签
endNode:结束节点信息
    id:节点内部id
    properties:节点详细信息
    labels:所属标签
relation:关系信息
    id:关系id
    type:关系名称
    properties:关系属性
调用示例List<Map<String, Object>> relationGraphByName = instance.getRelationGraphByName("框架", 20);

 

4.18.根据标签名称获取标签下所有节点

方法名getNodesByLabel
参数String label
参数说明label:标签名称
返回值[
  {
    "id": 84,
    "properties": {
      "id": "测试1"
    },
    "labels": [
      "权金龙测试3"
    ]
  },
  {
    "id": 86,
    "properties": {
      "id": "十四点五十四分"
    },
    "labels": [
      "权金龙测试3"
    ]
  },
  {
    "id": 87,
    "properties": {
      "name": "测试一下",
      "id": "十四点五十七分"
    },
    "labels": [
      "权金龙测试3"
    ]
  },
  {
    "id": 88,
    "properties": {
      "id": "十六点三十一分"
    },
    "labels": [
      "权金龙测试3"
    ]
  }
]
返回值说明id:节点id
properties:节点信息
labels:标签 
调用示例List<Map<String, Object>> nodesByLabel = instance.getNodesByLabel("TEST_TO");

 

4.19.执行cypher语句

方法名executeCypher
参数String cypher
Map<String, Object> params
参数说明cypher:cypher语句
params:参数(若cypher中使用占位符,该参数必须有值,否则可以传null)
返回值{
  "msg": "执行成功",
  "code": 0,
  "recordCount": 1,
  "results": [
    {
      "endNode": {
        "id": 87,
        "properties": {
          "name": "测试一下",
          "id": "十四点五十七分"
        },
        "labels": [
          "权金龙测试3"
        ]
      },
      "startNode": {
        "id": 85,
        "properties": {
          "name": "张三",
          "id": "测试1"
        },
        "labels": [
          "权金龙测试4"
        ]
      },
      "relation": {
        "id": 87,
        "type": "TEST_TO",
        "properties": {
          "ooo": "wawawawawa",
          "since": "16:59"
        }
      }
    }
  ],
  "queryType": "READ_ONLY"
}
返回值说明code:是否成功(0:成功; 2:失败)
msg:提示语
recordCount:结果集数量 
results:结果集信息 
queryType:查询类型(READ_ONLY:只读;READ_WRITE:写)
调用示例Map<String, Object> stringObjectMap = instance.executeCypher("MATCH p = (n)-[r]-() WHERE id(n) = 36 RETURN p", null);

 

本文档来自—microbee-http 丨 软件开发框架平台