amreeshtyagi/mongo-express

mongo-express

镜像概述和主要用途

mongo-express是一个基于Web的MongoDB管理界面，使用Node.js和Express框架开发。它提供了直观的可视化界面，用于管理MongoDB数据库、集合和文档，支持多种BSON数据类型，主要适用于开发环境中的MongoDB数据管理。

核心功能和特性

当前功能

• 连接多个数据库
• 连接并认证到单个数据库
• 以管理员身份认证以查看所有数据库
• 数据库黑白名单功能
• 查看/添加/重命名/删除集合
• 查看/添加/更新/删除文档
• 支持在文档中使用BSON数据类型
• 可指定文档列表中默认显示的键名

计划功能

• 支持副本集连接
• 站点认证
• REST接口

限制

• 文档必须包含document._id属性才能编辑
• 无GridFS支持（可能成为计划功能）
• 二进制BSON数据类型未经过充分测试
• JSON文档通过JavaScript虚拟机解析，因此Web界面可能被用于在服务器上执行*JavaScript**。mongo-express仅应在私有开发环境中使用。

使用场景和适用范围

适用于开发人员在本地或开发环境中快速管理MongoDB数据库，进行集合和文档的增删改查操作，支持多种BSON数据类型的可视化编辑。

使用方法和配置说明

安装

通过npm安装

bash
npm install mongo-express

全局安装

bash
npm install -g mongo-express

配置

1. 复制配置文件：将YOUR_PATH/node_modules/mongo-express/config.default.js复制为config.js
2. 配置默认键名（可选）：在defaultKeyNames字段中指定数据库、集合及默认显示键名，示例：

javascript
defaultKeyNames:{
  "world_db":{  // 数据库名称
    "continent":"cont_name", // 集合:字段
    "country":"country_name",
    "city":"name"
  },
  // 其他数据库配置...
}

若未指定集合的键名，默认使用_id。 3. 在config.js中填写MongoDB连接详情及其他配置选项。

运行

本地运行

bash
cd YOUR_PATH/node_modules/mongo-express/ && node app.js

全局安装后运行

bash
# 连接指定数据库
mongo-express -u user -p password -d database

# 以管理员身份运行
mongo-express -u superuser -p password

# 查看帮助
mongo-express -h

作为Express 4中间件挂载

javascript
var mongo_express = require('mongo-express/middleware')
var mongo_express_config = require('./mongo_express_config')

app.use('/mongo_express', mongo_express(mongo_express_config))

Docker容器运行

构建镜像

bash
docker build -t mongo-express .

运行容器（链接MongoDB容器）

bash
docker run -d -p 8081:8081 --link mongodb:mongodb mongo-express

环境变量配置

访问界面

访问 http://localhost:8081（独立运行时）或配置的config.site.baseUrl（作为中间件挂载时）。

BSON数据类型支持

mongo-express文档编辑器/查看器支持以下BSON数据类型：

原生JavaScript类型

字符串、数字、列表、布尔值、null等。JavaScript中的所有数字均为64位浮点数。

ObjectID/ObjectId

• ObjectID()：创建新的Object ID类型
• ObjectID(id)：使用24位十六进制字符串创建Object ID

ISODate

• ISODate()：创建当前时间的ISODate对象
• new Date()：也可用于创建日期对象
• ISODate(timestamp)：使用指定时间戳创建ISODate对象

DBRef/Dbref

• DBRef(collection, objectID)
• DBRef(collection, objectID, database)（database为可选参数）
  objectID是ID字符串，非ObjectID类型

Timestamp

• Timestamp()：创建值为0的Timestamp对象
• Timestamp(time, ordinal)：示例：Timestamp(ISODate(), 0)
  详情见MongoDB Timestamp数据类型

Code

• Code(code)：code可以是原生JavaScript函数或字符串，不支持指定作用域/上下文

MinKey

• MinKey()

MaxKey

• MaxKey()

Symbol

• Symbol(string)

未测试类型

• Binary/BinData

示例文档

json
{
  "_id": ObjectID(), // 或 ObjectId()
  "dates": {
    "date": ISODate("2012-05-14T16:20:09.314Z"),
    "new_date": ISODate(),
    "alternative": new Date()
  },
  "bool": true,
  "string": "hello world!",
  "list of numbers": [
    123,
    111e+87,
    4.4,
    -12345.765
  ],
  "reference": DBRef("collection", "4fb1299686a989240b000001"),
  "ts": Timestamp(ISODate(), 1),
  "minkey": MinKey(),
  "maxkey": MaxKey(),
  "func": Code(function() { alert('Hello World!') }),
  "symbol": Symbol("test")
}

许可证

MIT许可证

版权所有 (c) 2012 Chun-hao Hu

特此授予任何获得本软件及相关文档文件（以下简称“软件”）副本的人免费许可，不受限制地处理本软件，包括但不限于使用、复制、修改、合并、出版、分发、再许可和/或出售软件副本的权利，并允许向其提供软件的人这样做，但须符合以下条件：

上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。

本软件按“原样”提供，不提供任何明示或暗示的担保，包括但不限于适销性、特定用途适用性和非侵权性的担保。在任何情况下，作者或版权持有人均不对因软件或软件的使用或其他交易引起的任何索赔、损害或其他责任承担责任，无论是合同诉讼、侵权行为还是其他形式。