dbkoda

dbkoda [不再维护]

注意：不幸的是，这个项目不再正在积极发展。

最先进的MongoDB IDE

DBKODA是现代（JavaScript/Electron框架），用于MongoDB的开源IDE。它具有支持MongoDB数据库中的开发，管理和性能调整的功能。它具有丰富的功能集，包括：

• 具有自动完整，语法突出显示和代码格式的丰富文本编辑器
• 视觉解释计划与索引顾问
• 实时性能仪表板
• 图形聚合和命令构建器
• 一键访问MongoDB管理命令
• 磁盘存储分析
• SQL查询使用Apache Drill
• 数据负载和卸载实用程序
• 还有很多……查看我们的博客和网站以获取详细信息。

下载最新版本： V1.1.0下载最新Beta版本： V1.1RC9

该存储库定义了DBKODA的建筑物，用户接受测试（UAT），启动和包装工作流。

要求

• 节点8.9.1+
• 纱线1.3.2+
• 要安装和使用此存储库，您需要克隆dbkoda-ui和dbkoda-controller

设置

1. 确保dbkoda-ui ， dbkoda-controller和dbkoda是同一父文件夹中的兄弟姐妹文件夹，例如：

 root_folder
├── dbkoda-ui
├── dbkoda-controller
└── dbkoda

2. [重要]在dbkoda中，运行以下命令yarn dev:link 。这仅需要第一个设置。如果您要在Windows上安装，请使用yarn dev:link:win 。
3. 在所有3个存储库中运行yarn install 。
4. 要构建一个新的应用程序， yarn run pack 。对于Windows，使用yarn pack:win 。
5. 要构建该应用程序的版本，请运行yarn run dist:dev （无压缩）和yarn run dist （带有正常压缩）。对于Windows，请使用命令yarn dist:win 。
6. [可选]尝试以上命令后，将根据electron节点版本构建dbkoda-controller的本机模块。如果您想返回“ BYO”模式，则需要运行yarn dev:rebuild:current针对当前的node版本重建这些本机模块。
7. [可选]如果在任何这些步骤中都会遇到错误或不规则性，则可以在每个存储库中运行rm -rf node_modules ，然后再次yarn install 。如果您仍然有麻烦，请检查我们的常见问题解答或在我们的支持网站上提出新主题

config

您可以通过在dbkoda主文件夹中放置config.yml来配置dbkoda，如下所示：

 # Note: please use full path for all commands

# Local mongo binary path. dbKoda will detect your mongo binary upon first launch in your login
# shell
mongoCmd : /usr/local/bin/mongo 

Docker配置

如果您是通过Docker容器使用Mongo Shell，请配置Docker命令：

 dockerEnabled : true
docker :
  mongoCmd : docker run -it --rm mongo mongo
  mongoVersionCmd : docker run --rm mongo mongo --version

下面的配置用于通过现有的Docker容器运行Mongo Shell：

 dockerEnabled : true
docker :
  mongoCmd : docker exec -it CONTAINER_ID mongo
  mongoVersionCmd : docker exec CONTAINER_ID mongo --version

如果要通过Docker容器使用备份/还原，请配置Mongo OS命令。您需要指定Docker容器的安装点，以备份/重新设置Mongo文件。否则，您备份的数据将在容器存在之后被扫描。

 dockerEnabled : true
docker :
  mongoexportCmd : docker run --rm -v OS_PATH:CONTAINER_PATH mongo mongoexport
  mongoimportCmd : docker run --rm -v OS_PATH:CONTAINER_PATH mongo mongoimport
  mongodumpCmd : docker run --rm -v OS_PATH:CONTAINER_PATH mongo mongodump
  mongorestoreCmd : docker run --rm -v OS_PATH:CONTAINER_PATH mongo mongorestore

dbkoda主文件夹

Mac＆Linux： ~/.dbKoda/ Windows： c:Users<username>.dbKoda

发展

在开发模式下，dbkoda具有四种运行模式：byo，super_dev，dev和prod

带上自己的（BYO）开发模式（BYO）

您可以在此dbkoda下单独启动自己的dbkoda-ui或dbkoda-controller副本。您应该在这种模式下将dbkoda-ui和dbkoda-controller与dbkoda unlink ，以避免不必要的干扰。

使用命令yarn run byo或yarn byo 。

超级开发模式（super_dev）

在此模式下，启用了dbkoda-ui的热重载。当应用启动时，WebPack需要一些时间来首次包装UI，因此启动速度比其他模式慢得多。

yarn run super或yarn super

开发模式（开发）

yarn run dev或yarn dev

Devtron

Devtron是电子DevTools扩展程序，可帮助您检查，监视和调试应用程序，安装Devtron，请按照以下步骤操作。

1. yarn add -D devtron
2. 在Chrome DevTools中运行require('devtron').install() 。在BYO或Super Dev模式下，您应该在Splash屏幕窗口的DevTools中运行此操作。您可以杀死dbkoda-ui ，并在电子中创建一个新窗口（ CMD+N ），因此将显示一个新的Splash屏幕窗口。仅首次安装才需要此步骤。

React DevTools

chrome devtools的React组件检查员扩展

1. yarn add -D electron-react-devtools
2. 运行require('electron-react-devtools').install() 。在BYO或Super Dev模式下，您应该在Splash屏幕窗口的DevTools中运行此操作。您可以杀死dbkoda-ui ，并在电子中创建一个新窗口（ CMD+N ），因此将显示一个新的Splash屏幕窗口。仅首次安装才需要此步骤。

转移ES6代码

yarn run build或yarn build

清理移植的ES6代码

yarn run clean

包装到应用程序（产品）

yarn run pack

打包Windows yarn run pack:win

包装到安装程序（产品）

正常压缩（约3分钟）：

yarn run dist或yarn dist

FOW Windows： yarn run dist:win或yarn dist:win

没有压缩（最快，大约1分钟）：

yarn run dist:dev或yarn dist:dev

测试

以下命令将在tests中运行所有测试套件。要运行特定的测试套件，例如example1.test.js和example2.test.js带jest:dev命令：

yarn jest:dev "example[1,2].test.js"

发展（BYO）

这将运行eslint和jest与未包装的应用程序

yarn test或yarn test:dev

生产（产品）

这将运行eslint ，然后在包装应用程序上jest

yarn test:prod

只开玩笑（byo）

这是基于spectron的UAT

yarn jest:dev

仅开玩笑（prod）

与上一个类似，但在打包应用程序上jest

yarn jest:prod

仅运行

在以前包装的应用程序上jest

yarn jest:prod:runonly

UAT测试

设置以下用于UAT测试的环境变量：

• EC2_SHARD_CLUSTER_HOSTNAME
• ec2_shard_cluster_username
• EC2_SHARD_CLUSTER_PASSWORD
• atlas_server_hostname
• atlas_server_username
• atlas_server_password