{"id":24114745,"url":"https://github.com/oakten-software-engineering/ravendb-manager","last_synced_at":"2026-06-14T05:31:24.055Z","repository":{"id":56891016,"uuid":"101998284","full_name":"oakten-software-engineering/ravendb-manager","owner":"oakten-software-engineering","description":"Manage your RavenDB Document Database","archived":false,"fork":false,"pushed_at":"2017-09-05T14:02:22.000Z","size":8,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-05-03T22:06:15.949Z","etag":null,"topics":["ravendb","ruby"],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oakten-software-engineering.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-08-31T12:26:13.000Z","updated_at":"2024-10-26T18:41:59.000Z","dependencies_parsed_at":"2022-08-20T16:01:00.902Z","dependency_job_id":null,"html_url":"https://github.com/oakten-software-engineering/ravendb-manager","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/oakten-software-engineering/ravendb-manager","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oakten-software-engineering%2Fravendb-manager","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oakten-software-engineering%2Fravendb-manager/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oakten-software-engineering%2Fravendb-manager/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oakten-software-engineering%2Fravendb-manager/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oakten-software-engineering","download_url":"https://codeload.github.com/oakten-software-engineering/ravendb-manager/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oakten-software-engineering%2Fravendb-manager/sbom","scorecard":{"id":700511,"data":{"date":"2025-08-11","repo":{"name":"github.com/oakten-software-engineering/ravendb-manager","commit":"47051d1c30b8c7c3c23c0dd0a2c5722ec0c63dde"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.6,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/7 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-22T05:06:52.605Z","repository_id":56891016,"created_at":"2025-08-22T05:06:52.605Z","updated_at":"2025-08-22T05:06:52.605Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34310801,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-14T02:00:07.365Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ravendb","ruby"],"created_at":"2025-01-11T05:24:26.894Z","updated_at":"2026-06-14T05:31:23.824Z","avatar_url":"https://github.com/oakten-software-engineering.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RavenDB Manager\nThis simple library helps you to manage your [RavenDB](https://ravendb.net/) servers. It has been tested with RavenDB 3.0 and 3.5.\n\nYou will need to provide an API key. Some commands will require `Admin` privileges on the `\u003csystem\u003e` database. The API key feature is only available in commercial licenced versions of RavenDB.\n\n## Usage\n\n### Connect to Server\n```ruby\nrequire 'ravendb-manager'\nmanager = RavenDBManager.create(\"http://raven.server:8088\", \"apikey/raBreMBH9xv1aanDPZGx23Kv6ow7mrd\")\n```\n\n### Get Server Version\nWill return the build and product version of the server.\n```ruby\nmanager.version\n=\u003e {\"ProductVersion\"=\u003e\"d3c9854\", \"BuildVersion\"=\u003e30172}\n```\n\n### List Databases\nWill list all databases on the server.\n```ruby\nmanager.list_databases\n=\u003e [\"DB1\", \"DB2\"]\n```\n\n### List Filesystems\nWill list all filesystems on the server.\n```ruby\nmanager.list_filesystems\n=\u003e [\"Filesystem1\", \"Filesystem2\"]\n```\n\n### Get Alerts\nGets RavenDB alerts from a database.\n```ruby\n# Get Alerts of System Database\nmanager.alerts\n=\u003e [{\"Title\"=\u003e\"Index disk 'C:\\\\' has 2697MB (4%) of free space. Indexing will be disabled when it reaches 2048MB.\", \"CreatedAt\"=\u003e\"2017-04-18T14:35:25.1926262Z\", \"Observed\"=\u003efalse, \"LastDismissedAt\"=\u003enil, \"Message\"=\u003enil, \"AlertLevel\"=\u003e\"Warning\", \"Exception\"=\u003enil, \"UniqueKey\"=\u003e\"Free space warning (index)\"}]\n\n# Get Alerts of a specific database\nmanager.alerts('DB1')\n=\u003e []\n```\n\n### Create Database\nCreates a new database.\n```ruby\nmanager.create_database(\"DB3\")\n\n# Use Voron as storage backend\nmanager.create_database(\"DB3\", true)\n```\n\n### Create Filesystem\nCreates a new filesystem.\n```ruby\nmanager.create_filesystem(\"Filesystem3\")\n```\n\n### Store Document\nStores a document. Setting metadata is not (yet) supported.\n```ruby\nmanager.put_document(\"DB1\", \"document1\", {'Name' =\u003e 'Ivan Vorpatril', 'Age' =\u003e 35})\n=\u003e \"document1\"\n```\n\n### Read Document\nReads a document. Will return `nil` if key is not found.\n```ruby\nmanager.get_document(\"DB1\", \"document1\")\n=\u003e {\"Name\"=\u003e\"Ivan Vorpatril\", \"Age\"=\u003e35}\n\nmanager.get_document(\"DB1\", \"does_not_exist\")\n=\u003e nil\n```\n\n### Compact Database\nStarts compaction of a database. This process runs asynchronously. You have to check the result with the returned OperationId.\n\n**Important**: Database will be **offline** during the compact process\n```ruby\nopid = manager.compact_database(\"DB1\")\n=\u003e 8\nmanager.get_operation_status(opid)\n=\u003e {\"Completed\"=\u003etrue, \"Faulted\"=\u003efalse, \"State\"=\u003enil}\n```\n\n### Get Database Indexing Status\n```ruby\nmanager.get_indexing_status('DB1')\n=\u003e \"Indexing\"\n```\n\n### Get Database Statistics\n```ruby\nmanager.database_statistics(\"DB1\")\n=\u003e {\"StorageEngine\"=\u003e\"Esent\", \"LastDocEtag\"=\u003e\"01000000 [...]\n```\n\n### Get Server Statistics\n```ruby\nmanager.server_statistics\n=\u003e {\"ServerName\"=\u003enil, \"TotalNumberOfReques [...]\n```\n\n### Create new API Key\nCreate a new API key. If an API key with the same name already exists it will be replaced. Returns the newly generated API key.\n```ruby\n# Automaticly genrate secret\nmanager.create_api_key('apikey')\n=\u003e \"apikey/raBreMBH9xv1aanDPZGx23Kv6ow7mrd\"\n\n# Use explicit secret\nmanager.create_api_key('apikey', 'kYep0o8QLTqdVSZygJ7xMFO')\n=\u003e \"apikey/kYep0o8QLTqdVSZygJ7xMFO\"\n```\n\n### List API Keys\nReturns a `Hash` with all API keys.\n```ruby\nmanager.list_api_keys\n=\u003e {\"apikey\"=\u003e{:databases=\u003e[{\"Admin\"=\u003etrue, \"TenantId\"=\u003e\"*\", \"ReadOnly\"=\u003efalse}, {\"Admin\"=\u003etrue, \"TenantId\"=\u003e\"\u003csystem\u003e\", \"ReadOnly\"=\u003efalse}], :secret=\u003e\"raBreMBH9xv1aanDPZGx23Kv6ow7mrd\"}}\n```\n\n### Add Database Permission to API Key\nAdds permissions for a database to an API key.\n\n```ruby\n# Add read and write permission\nmanager.add_db_to_api_key('apikey', 'DB1')\n\n# Add admin permission\nmanager.add_db_to_api_key('apikey', 'DB2', true, false)\n\n# Add read only permission\nmanager.add_db_to_api_key('apikey', 'DB3', false, true)\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foakten-software-engineering%2Fravendb-manager","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foakten-software-engineering%2Fravendb-manager","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foakten-software-engineering%2Fravendb-manager/lists"}