PLATER-GRAPH 1.9.8

PLATER

PLATER是一个在neo4j或redis图形数据库上建立REST端点的服务。PLATER在Neo4j后端数据结构上有一些限制，不能完全利用。

数据结构限制

• 所有节点都应该有一个id以便可搜索（用于查询单个节点）
• 所有边都应该有一个id以便可搜索（用于生成ReasonerAPI）
• 建议数据遵守Translator Reasoner API。

安装

直接运行Web服务器

创建虚拟环境并激活。

cd <PLATER-ROOT>
python<version> -m venv venv
source venv/bin/activate

安装依赖项

pip install -r PLATER/requirements.txt

配置PLATER设置

将设置填充到.env-template文件中，并保存为repo根目录中的.env。

 WEB_HOST=0.0.0.0
 WEB_PORT=8080
 DB_HOST=<neo4j_or_redis_address>
 DB_USERNAME=<user name required for neo4j, empty for redis>
 DB_PASSWORD=''
 DB_PORT=<redis port or neo4j http port>
 DB_NAME=<db name for redis, uses default db for neo4j>
 DB_TYPE=<use values 'redis' or 'neo4j'>
 PLATER_TITLE='Plater'
 PLATER_VERSION='1.0.0'

运行脚本

./main.sh

DOCKER

或构建一个镜像并运行。

  cd PLATER
  docker build --tag <image_tag> .
  cd ../

 docker run --env-file .env\
  --name plater\
  -p 8080:8080\
  --network <network_where_neo4j_is_running>\
  plater-tst

使用Automat服务器进行聚类[可选]

您还可以通过公共网关(Automat)为多个plater实例提供服务。有关具体说明，请参阅AUTOMAT的readme

杂项

/about端点

可以使用/about端点来展示当前PLATER实例的元数据。这些元数据来自<repo-root>/PLATER/about.json文件。可以编辑此文件的正文以适应需要。在容器化环境中，建议将此文件作为卷挂载。

例如

docker run -p 0.0.0.0:8999:8080  \
              --env DB_HOST=<your_db_host> \
              --env DB_PORT=<your_db_port> \
              --env DB_USERNAME=<db_user_name required for neo4j, ignored for redis> \
              --env DB_PASSWORD=<db_password> \
              --env DB_NAME=<required for redis> \ 
              --env DB_TYPE=<redis or neo4j> \  
              --env WEB_HOST=0.0.0.0 \
              -v <your-custom-about>:/<path-to-plater-repo-home>/plater/about.json \
              --network=<docker_network_neo4j_is_running_at> \    
               <image_tag>