sidorares / sidorares/node-mysql2

ZSTD compression support

Open
#1,815 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
4.4k
Forks
680
Avg merge
9h 7m
Merged PRs (30d)
59

Description

currently only CLIENT_COMPRESS capability flag is supported ( inflate/deflate - https://www.rfc-editor.org/rfc/rfc1951.html )

when server sends CLIENT_ZSTD_COMPRESSION_ALGORITHM (1UL << 26) the client may elect to accept it

http://facebook.github.io/zstd/

https://dev.mysql.com/doc/dev/mysql-server/latest/page_protocol_basic_compression.html
https://dev.mysql.com/doc/dev/mysql-server/latest/group__group__cs__capabilities__flags.html

looks like not in the node core, and most packages are compiled binary.
have as optional dependency and accept if installed?

https://github.com/mongodb-js/zstd

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the existing CLIENT_COMPRESS inflate/deflate capability handling and compare it with the MySQL protocol documentation linked in the issue. Evaluate the optional mongodb-js/zstd dependency path; done means negotiated CLIENT_ZSTD_COMPRESSION_ALGORITHM support with tests, but the issue names no files or test entry point.

Written by the indexing model from the issue text.

Assessment

Tech stack
mysql, node.js, typescript
Domain
backend, databases
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.