{"id":41361220,"url":"https://github.com/ctala/aurora-mysql2-cluster","last_synced_at":"2026-01-23T07:48:56.891Z","repository":{"id":57186976,"uuid":"171027841","full_name":"ctala/aurora-mysql2-cluster","owner":"ctala","description":"Managed Pool Connections for Aurora DB","archived":false,"fork":false,"pushed_at":"2019-03-09T16:44:12.000Z","size":11,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-12-22T21:44:29.779Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/ctala.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}},"created_at":"2019-02-16T16:56:15.000Z","updated_at":"2019-03-09T16:44:13.000Z","dependencies_parsed_at":"2022-08-28T13:00:11.809Z","dependency_job_id":null,"html_url":"https://github.com/ctala/aurora-mysql2-cluster","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ctala/aurora-mysql2-cluster","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctala%2Faurora-mysql2-cluster","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctala%2Faurora-mysql2-cluster/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctala%2Faurora-mysql2-cluster/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctala%2Faurora-mysql2-cluster/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ctala","download_url":"https://codeload.github.com/ctala/aurora-mysql2-cluster/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctala%2Faurora-mysql2-cluster/sbom","scorecard":{"id":311601,"data":{"date":"2025-08-11","repo":{"name":"github.com/ctala/aurora-mysql2-cluster","commit":"8480b1de23d81948e20b3adb75f4f60466cd8ce2"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.6,"checks":[{"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":"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":"Code-Review","score":0,"reason":"Found 0/21 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":"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":"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":"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":"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":"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-17T23:15:55.036Z","repository_id":57186976,"created_at":"2025-08-17T23:15:55.036Z","updated_at":"2025-08-17T23:15:55.036Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28683996,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-23T05:48:07.525Z","status":"ssl_error","status_checked_at":"2026-01-23T05:48:07.129Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":[],"created_at":"2026-01-23T07:48:56.352Z","updated_at":"2026-01-23T07:48:56.881Z","avatar_url":"https://github.com/ctala.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# aurora-mysql2-cluster\nManaged Pool Connections for Aurora DB. \n\nThis module will create 2 Mysql2 pools using the Amazon Aurora endpoints. Read replicas will be automatically optimized by Amazon.\n\nAlso executes plain Mysql queries through the pools. \n\n# Configuration\n\nThis module will read the enviromental variables in order to find the information regarding to the write and read endpoints for the Aurora Cluster. If the information for read is not provided, it will use the corresponding variable for write.\n\n## Enviromental Variables\n\n### Writter \n\n* DB_HOST\n* DB_USER\n* DB_DATABASE\n* DB_PORT\n* DB_PASS\n\n### Reader\n\nWhile we can use an Aurora writter endpoint to read is not recommended. All the information not found in the enviroment will use the writter variables by default.\n\n* DB_HOST_DEV (RECOMMENDED)\n* DB_USER_DEV (OPTIONAL)\n* DB_DATABASE_DEV (OPTIONAL)\n* DB_PORT_DEV (OPTIONAL)\n* DB_PASS_DEV (OPTIONAL)\n\n\n\n## Creating the object\n\nUsing the enviromental variables.\n\n```\nconst AuroraPool = require(\"aurora-mysql2-cluster\");\n\nlet auroraPool = new AuroraPool();\n```\n\n### Using params \n\n```\nconst AuroraPool = require(\"aurora-mysql2-cluster\");\n\nlet writterInfo = {\n    host : \"\",\n    user : \"\",\n    database : \"\",\n    port : \"\",\n    password : \"\"\n}\n\nlet readerInfo = {\n    host : \"\",\n    user : \"\",\n    database : \"\",\n    port : \"\",\n    password : \"\"\n}\n\nlet auroraPool = new AuroraPool(writterInfo,readerInfo);\n```\n\n### Amazon Systems Manager Agent (SSM)\n\nA good practice is to keep passwords encrypted and database information safe. That is why by default we can use SSM variables directly from our account. Any variable that we want to be loaded from AWS SSM just need to start with the pattern \"ssm//\".\n\nFor example :\n\n```\nlet writterInfo = {\n    host : \"ssm//RDS_GW_HOST_WRITE\",\n    password : \"ssm//RDS_GW_HOST_PASSWORD\"\n}\n```\n\nIn this case we will load the host and the password from SSM ( Assuming you have permissions ). All passwords MUST be encrypted in SSM.\n\n### Read Query\n\n```\nauroraPool.read(query);\n```\n\nReturn Mysql2 pool query result as a promise.\n\n### Write Query\n\n```\nauroraPool.write(query);\n```\n\nReturn Mysql2 pool query result as a promise.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fctala%2Faurora-mysql2-cluster","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fctala%2Faurora-mysql2-cluster","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fctala%2Faurora-mysql2-cluster/lists"}