{"id":21558120,"url":"https://github.com/koopjs/koop-cache-apache-ignite","last_synced_at":"2025-07-15T20:39:57.540Z","repository":{"id":221251807,"uuid":"748879414","full_name":"koopjs/koop-cache-apache-ignite","owner":"koopjs","description":null,"archived":false,"fork":false,"pushed_at":"2024-06-24T05:06:29.000Z","size":246,"stargazers_count":0,"open_issues_count":6,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-18T03:32:35.388Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/koopjs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-01-26T23:53:49.000Z","updated_at":"2024-02-06T22:23:55.000Z","dependencies_parsed_at":"2025-01-24T10:43:01.746Z","dependency_job_id":"5d37bf5c-8a1c-4d19-b904-fcd86918298d","html_url":"https://github.com/koopjs/koop-cache-apache-ignite","commit_stats":null,"previous_names":["koopjs/koop-cache-apache-ignite"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/koopjs/koop-cache-apache-ignite","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koopjs%2Fkoop-cache-apache-ignite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koopjs%2Fkoop-cache-apache-ignite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koopjs%2Fkoop-cache-apache-ignite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koopjs%2Fkoop-cache-apache-ignite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/koopjs","download_url":"https://codeload.github.com/koopjs/koop-cache-apache-ignite/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koopjs%2Fkoop-cache-apache-ignite/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265458050,"owners_count":23769042,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-11-24T08:14:02.794Z","updated_at":"2025-07-15T20:39:57.522Z","avatar_url":"https://github.com/koopjs.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# koop-cache-apache-ignite\n\n[![npm version][npm-img]][npm-url]\n![coverage](./coverage.svg)\n\nThis is a \"cache\" plugin for the Koop Web Server.  It adheres to Koop's [plugin specification](https://koopjs.github.io/docs/development/cache).  Registering this plugin with Koop will cause it to replace its in-memory cache with a cache backed by Apache Ignite.\n\nAn important fact about Koop cache plugins -  registering a cache does not necessarily mean data from provider plugins will be cached.  The provider must set a `ttl` (in seconds) on its data payload for it to be cached by any cache-plugin. This gives the provider developer ultimate control over data caching.\n\n## Why use the Apache-Ignite plugin?\nKoop's default cache uses a simple key/value store to cache data in-memory.  This means you are using a chunk of your deployment machine's memory for the cache.  The size of cache entries  isn't limited by the in-memory cache-plugin (though the number of entries is limited), which makes it hard to plan for how much memory you need. In contrast, using a backing store like Apache Ignite is a much more scalable solution as you can provision the Ignite instance independently and it's memory consumption has no impact on the web-server.\n\nUsing a plugin like the Apache-Ignite cache also benefits deployments that leverage horizontal scaling of the web-server.  Imagine you are using the default in-memory cache and that you are deploying multiple Koop server instances with traffic routed to each by a load balancer.  In this architecture, each Koop server has its own cache. Caching is therefore inefficient; a cache entry on server (A) is not accessible to server (B). Rather, each server instance has to build up its own cache.  Alternatively, if you use the Apache-Ignite plugin with an independently deployed Apache-Ignite backing store, each Koop server instance will share a single cache; entries cached by server (A) can be retrieved by server (B).\n\n## Usage\n### As a Koop cache plugin\n\n#### With registration options:\n```js\nconst Koop = require('koop')\nconst koop = new Koop()\nconst { Cache } = require('@koopjs/cache-apache-ignite')\nkoop.register(Cache, {\n  connStr: '127.0.0.1:10800', // connection string for the Ignite deployment,\n  cacheName: 'koop-ignite-cache' // a name to use for the cache; will be created if not found\n})\n```\n\n#### With options set in \"node-config\" module:\n\nCreate a configuration json file (see [node-config](https://www.npmjs.com/package/config) for details).\n```json\n{\n  \"apacheIgnite\": {\n    \"connStr\": \"127.0.0.1:10800\",\n    \"cacheName\": \"koop-ignite-cache\"\n  }\n}\n```\n\nThen register the cache plugin without options.\n```js\nconst Koop = require('koop')\nconst koop = new Koop()\nconst { Cache } = require('@koopjs/cache-apache-ignite')\nkoop.register(Cache)\n```\n\n[npm-img]: https://img.shields.io/npm/v/@koopjs/cache-apache-ignite.svg?style=flat-square\n[npm-url]: https://www.npmjs.com/package/@koopjs/cache-apache-ignite","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoopjs%2Fkoop-cache-apache-ignite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkoopjs%2Fkoop-cache-apache-ignite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoopjs%2Fkoop-cache-apache-ignite/lists"}