Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/idnan/go-mongo-indexer
CLI tool to manage mongo database collection indexes through json files
https://github.com/idnan/go-mongo-indexer
golang indexer indexes mongodb mongodb-indexes
Last synced: about 1 month ago
JSON representation
CLI tool to manage mongo database collection indexes through json files
- Host: GitHub
- URL: https://github.com/idnan/go-mongo-indexer
- Owner: Idnan
- Created: 2018-10-14T17:39:37.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-07T00:49:26.000Z (over 1 year ago)
- Last Synced: 2023-08-17T00:10:50.205Z (about 1 year ago)
- Topics: golang, indexer, indexes, mongodb, mongodb-indexes
- Language: Go
- Homepage:
- Size: 40 KB
- Stars: 26
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# go-mongo-indexer
> CLI utility to manage mongodb collection indexes
[](https://adnanahmed.info)
[](https://travis-ci.org/idnan/go-mongo-indexer)
[](https://goreportcard.com/report/github.com/gohugoio/hugo)
## Usage
```shell
indexer --config
--uri
--database
--apply
```
Details of options is listed below
| **Option** | **Required?** | **Description** |
|------------|---------------|--------------------------------------------------------------------------------------------------------------|
| `config` | Yes | Path to [indexes configuration file](#config-format) |
| `uri` | Yes | MongoDB connection string e.g. `mongodb://127.0.0.1:27017` |
| `database` | Yes | Database name |
| `apply` | No | Whether to apply the indexes on collections or not. If not given, it will show the plan that will be applied |
## Config Format
The configuration file is just a simple json file containing the indexes to be applied. This file is an array of objects. Where each object has details like collection name, cap size and indexes for this specific collection.
```javascript
[
{
"collection": "order", // name of collection
"cap": null, // Number of bytes
"index": [ // Array of index details
{"cartId": 1}, // An ascending order index
{"status": -1}, // Descending order index
{"orderId": 1},
{"groupId": 1},
{"currency": 1},
{"createdAt": -1},
{"orderNumber": 1, "type": 1}, // Composite index on orderNumber and type
{"type": -1, "paymentStatus": -1, "payment.paymentMethod": -1}
]
},
{
"collection": "collection_name",
"cap": null,
"index": [
{"userId": -1},
{"username": 1},
{"orderId": 1, "_unique": 1}, // creates a `unique index`
{"createdAt": -1, "_expireAfterSeconds": 500} // creates a `expires index` that will delete document after given number of seconds
]
}
....
....
....
]
```
**Note** `cap`ping is still progress not yet supported
## Examples
> See list of index changes before applying
```shell
indexer --config "/path/to/xyz.json" --uri "mongodb://127.0.0.1:27017/database_name" --database "database_name"
```
> Apply the index changes
```shell
$ indexer --config "/path/to/xyz.json" --uri "mongodb://127.0.0.1:27017/database_name" --database "database_name" --apply
```
## Todo
* [ ] Write tests
* [x] Collection capping
* [x] Support for `_unique` and `_expireAfterSeconds` indexes
## Contributing
Anyone is welcome to contribute, however, if you decide to get involved, please take a moment to review the guidelines:
* Only one feature or change per pull request
* Write meaningful commit messages
* Follow the existing coding standards
## License
MIT © [Adnan Ahmed](https://github.com/idnan)