pg_hash_func 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 47be51c825e894ee45f7988db38544022028bb084cc82448f14409547e5eef38
+  data.tar.gz: 48541492aa6ac7815e05580c9b76fd522b75b033d43edc76e73ccb32ef55baad
+SHA512:
+  metadata.gz: 5255d4ab2d65c8ce8a5e9be8be446f40932b0ae2861d4c9794a513f8746f94381adcc3e968a06191ef3c66dc85295618ce5be70887b2658935cec12e56689c4c
+  data.tar.gz: 7e80636f9c6a53328f3d46b0e096aba3efa44618d97b72b70b702c6f05ce721a25a7acb1f5ce953b8d3688b49b0ccb70b80a72cf3cb82733c12ff94cbdd8812e

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,50 @@
+# .rubocop.yml
+
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.0
+  Exclude:
+    - "bin/console"
+    - "benchmarks/**/*"
+    - "vendor/**/*"
+    - "tmp/**/*"
+
+Style/Documentation:
+  Enabled: false
+
+Naming/MethodParameterName:
+  MinNameLength: 2
+  AllowNamesEndingInNumbers: true
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 15
+  Exclude:
+    - "lib/pg_hash_func/hasher.rb"
+
+Metrics/AbcSize:
+  Max: 20
+  Exclude:
+    - "lib/pg_hash_func/hasher.rb"
+
+Metrics/BlockLength:
+  Max: 100
+  Exclude:
+    - "pg_hash_func.gemspec"
+    - "spec/**/*_spec.rb"
+
+RSpec/ExampleLength:
+  Max: 10
+
+RSpec/MultipleExpectations:
+  Max: 5
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.ruby-version

@@ -0,0 +1 @@
+3.4.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at shayonj@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec
+
+group :development, :test do
+  gem "benchmark-ips"
+  gem "bundler"
+  gem "pg"
+  gem "rake", "~> 13.0"
+  gem "rspec", "~> 3.0"
+  gem "rubocop", "~> 1.60" # Use a recent version
+  gem "rubocop-performance"
+  gem "rubocop-rake"
+  gem "rubocop-rspec"
+end

data/Gemfile.lock

@@ -0,0 +1,84 @@
+PATH
+  remote: .
+  specs:
+    pg_hash_func (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.3)
+    benchmark-ips (2.14.0)
+    diff-lcs (1.6.1)
+    json (2.11.3)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    parallel (1.27.0)
+    parser (3.3.8.0)
+      ast (~> 2.4.1)
+      racc
+    pg (1.5.9)
+    prism (1.4.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.10.0)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    rubocop (1.75.3)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.44.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-performance (1.25.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
+    rubocop-rspec (3.6.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+
+PLATFORMS
+  arm64-darwin-24
+  ruby
+
+DEPENDENCIES
+  benchmark-ips
+  bundler
+  pg
+  pg_hash_func!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.60)
+  rubocop-performance
+  rubocop-rake
+  rubocop-rspec
+
+BUNDLED WITH
+   2.6.8

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Shayon Mukherjee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,149 @@
+# pg_hash_func
+
+[![CI](https://github.com/shayonj/pg_hash_func/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/shayonj/pg_hash_func/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/pg_hash_func.svg)](https://badge.fury.io/rb/pg_hash_func)
+
+Determine the target partition index for an integer key according to PostgreSQL's default hash strategy, without querying the database.
+
+**Supported Types:**
+
+- **`bigint` (`int8`)**: Use `PgHashFunc.calculate_partition_index_bigint`.
+- **`integer` (`int4`)** and **`smallint` (`int2`)**: Use `PgHashFunc.calculate_partition_index_int4`. (PostgreSQL uses the same underlying hash function for both `int4` and `int2`.)
+
+**Limitations:**
+
+- Only replicates the default `hash` partitioning strategy.
+- Only supports integer-based keys (`bigint`, `integer`, `smallint`).
+- Does not support hashing other data types (text, dates, floats, etc.).
+- Does not support other partitioning strategies (list, range).
+- Assumes PostgreSQL's standard internal seed and magic constants by default.
+
+**Compatibility:**
+
+- Ruby `>= 3.0.0`
+- PostgreSQL `>= 11` (tested up to 16)
+
+Note: PRs and support very much welcome
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pg_hash_func'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install pg_hash_func
+
+## Usage
+
+**Example 1: Partitioning by bigint (e.g., User ID)**
+
+```ruby
+TABLE_PREFIX_BIGINT = "events"
+USER_ID = 123_456_789_012_345 # bigint value
+NUM_PARTITIONS_BIGINT = 16
+index_bigint = PgHashFunc.calculate_partition_index_bigint(
+  value: USER_ID,
+  num_partitions: NUM_PARTITIONS_BIGINT
+)
+
+# Construct the partition table name
+partition_name_bigint = [TABLE_PREFIX_BIGINT, index_bigint].join("_")
+
+puts "User #{USER_ID} (bigint) belongs to partition: #{partition_name_bigint}"
+# => User 123456789012345 (bigint) belongs to partition: events_14
+```
+
+**Example 2: Partitioning by integer (e.g., Tenant ID)**
+
+```ruby
+TABLE_PREFIX_INT = "tenant_data"
+TENANT_ID = 987_654 # An integer value (fits in int4/int2)
+NUM_PARTITIONS_INT = 32
+
+# Calculate the index using the int4 function
+# This also works correctly if TENANT_ID was a smallint
+index_int = PgHashFunc.calculate_partition_index_int4(
+  value: TENANT_ID,
+  num_partitions: NUM_PARTITIONS_INT
+)
+
+partition_name_int = [TABLE_PREFIX_INT, index_int].join("_")
+
+puts "Tenant 987654 (int) belongs to partition: tenant_data_28"
+# => "tenant_data_22"
+```
+
+**Example 3: Two-Level Partitioning (bigint then int4)**
+
+```ruby
+TABLE_PREFIX_MULTI = "user_settings"
+CUSTOMER_ID = 555_444_333_222_111 # bigint
+SETTING_TYPE = 101                # integer
+NUM_PARTITIONS_L1 = 64            # For CUSTOMER_ID
+NUM_PARTITIONS_L2 = 8             # For SETTING_TYPE
+
+# Calculate index for each level separately using the correct function
+index_l1 = PgHashFunc.calculate_partition_index_bigint(value: CUSTOMER_ID, num_partitions: NUM_PARTITIONS_L1)
+index_l2 = PgHashFunc.calculate_partition_index_int4(value: SETTING_TYPE, num_partitions: NUM_PARTITIONS_L2)
+
+partition_name_multi = [TABLE_PREFIX_MULTI, index_l1, index_l2].join("_")
+
+puts "Settings for Customer=#{CUSTOMER_ID}, Type=#{SETTING_TYPE} belong to: #{partition_name_multi}"
+# => Settings for Customer=555444333222111, Type=101 belong to: user_settings_44_0
+```
+
+**Raw Hash Function**
+
+Access the underlying PostgreSQL `hashint8extended` function directly. Primarily useful for debugging or specific integration scenarios.
+
+```ruby
+USER_ID = 123_456_789_012_345 # From Example 1
+
+raw_hash_bigint = PgHashFunc.hashint8extended(value: USER_ID)
+
+puts "Raw bigint hash for #{USER_ID}: #{raw_hash_bigint}"
+# => Raw bigint hash for 123456789012345: 1245190300417211467
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Releasing
+
+1.  Update the `VERSION` constant in `lib/pg_hash_func/version.rb`.
+2.  Commit the changes.
+3.  Run the release script, providing the version number:
+    ```bash
+    scripts/release.sh <VERSION>
+    # e.g., scripts/release.sh 0.1.0
+    ```
+    This script will:
+    - Build the gem.
+    - Push the gem to RubyGems.
+    - Create a git tag (e.g., `v0.1.0`).
+    - Push the tag to GitHub.
+    - Clean up the local gem file.
+4.  Create a release on GitHub using the tag created.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/shayonj/pg_hash_func.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PgHashFunc project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/shayonj/pg_hash_func/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+# Run specs
+RSpec::Core::RakeTask.new(:spec)
+
+# Run RuboCop
+RuboCop::RakeTask.new(:rubocop)
+
+# Default task: run specs and RuboCop
+task default: %i[spec rubocop]

data/benchmarks/file.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'benchmark/ips'
+require 'pg'
+require_relative '../lib/pg_hash_func'
+DB_CONFIG = {
+  dbname: ENV['PGDATABASE'] || 'postgres',
+  user: ENV['PGUSER'] || 'postgres',
+  password: ENV['PGPASSWORD'],
+  host: ENV['PGHOST'] || 'localhost',
+  port: ENV['PGPORT'] || 5432
+}.compact
+
+# Constants from the gem
+SEED = PgHashFunc::Hasher::HASH_PARTITION_SEED
+MAGIC = PgHashFunc::Hasher::PARTITION_MAGIC_CONSTANT
+UINT64_MODULUS = PgHashFunc::Hasher::UINT64_MASK + 1 # 2^64
+
+TEST_DATA = [
+  [1, 16],
+  [-1, 16],
+  [540_364, 16],
+  [2**31 - 1, 32],
+  [-(2**31), 32],
+  [2**63 - 1, 64],
+  [-(2**63), 64],
+  [123_456_789_012_345, 1024],
+  [9_223_372_036_854_775_807, 2048]
+].freeze
+
+SQL_QUERY = <<~SQL
+  SELECT ( ( ((hashint8extended($1::bigint, $2::bigint)::numeric + $3::numeric) % $5::numeric) % $4::numeric ) + $4::numeric ) % $4::numeric;
+SQL
+
+begin
+  conn = PG.connect(DB_CONFIG)
+  puts 'Connected to PostgreSQL.'
+rescue PG::ConnectionBad => e
+  puts 'Failed to connect to PostgreSQL. Ensure DB is running and configured correctly.'
+  puts "Error: #{e.message}"
+  exit(1)
+end
+
+puts 'Warming up...'
+
+Benchmark.ips do |x|
+  x.report('Ruby Calculation') do
+    TEST_DATA.each do |key, num_partitions|
+      PgHashFunc.calculate_partition_index(
+        value: key,
+        num_partitions: num_partitions,
+        seed: SEED,
+        magic_constant: MAGIC
+      )
+    end
+  end
+
+  x.report('SQL Query') do
+    TEST_DATA.each do |key, num_partitions|
+      result = conn.exec_params(SQL_QUERY, [key, SEED, MAGIC, num_partitions, UINT64_MODULUS])
+      result.getvalue(0, 0).to_i
+    end
+  end
+
+  x.compare!
+end
+
+conn.close if conn && !conn.finished?
+puts 'Disconnected from PostgreSQL.'
+
+# Connected to PostgreSQL.
+# Warming up...
+# ruby 3.4.2 (2025-02-15 revision d2930f8e7a) +PRISM [arm64-darwin24]
+# Warming up --------------------------------------
+#     Ruby Calculation     6.755k i/100ms
+#            SQL Query   320.000 i/100ms
+# Calculating -------------------------------------
+#     Ruby Calculation     67.103k (± 3.4%) i/s   (14.90 μs/i) -    337.750k in   5.040734s
+#            SQL Query      3.192k (± 2.6%) i/s  (313.26 μs/i) -     16.000k in   5.016067s
+
+# Comparison:
+#     Ruby Calculation:    67102.7 i/s
+#            SQL Query:     3192.2 i/s - 21.02x  slower
+
+# Disconnected from PostgreSQL.

data/lib/pg_hash_func/hasher.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+# Based on PostgreSQL's src/common/hashfn.c (Bob Jenkins' lookup3 hash)
+# and src/backend/access/hash/hashfunc.c
+
+# Namespace for PgHashFunc implementation details.
+module PgHashFunc
+  # Internal implementation of PostgreSQL hashing logic.
+  module Hasher
+    # Constants derived from PostgreSQL source/behavior
+    HASH_PARTITION_SEED = 0x7A5B22367996DCFD
+    PARTITION_MAGIC_CONSTANT = 0x4992394d24f64163
+
+    UINT32_MASK = 0xFFFFFFFF
+    UINT64_MASK = 0xFFFFFFFFFFFFFFFF
+
+    # Corresponds to rot(x, k) -> pg_rotate_left32(x, k)
+    def self.rot(value, rotation_bits)
+      value &= UINT32_MASK
+      (((value << rotation_bits) | (value >> (32 - rotation_bits))) & UINT32_MASK)
+    end
+
+    # Corresponds to mix(a, b, c) macro in hashfn.c
+    def self.mix(state)
+      a, b, c = state
+      a = (a - c) & UINT32_MASK
+      a ^= rot(c, 4)
+      c = (c + b) & UINT32_MASK
+      b = (b - a) & UINT32_MASK
+      b ^= rot(a, 6)
+      a = (a + c) & UINT32_MASK
+      c = (c - b) & UINT32_MASK
+      c ^= rot(b, 8)
+      b = (b + a) & UINT32_MASK
+      a = (a - c) & UINT32_MASK
+      a ^= rot(c, 16)
+      c = (c + b) & UINT32_MASK
+      b = (b - a) & UINT32_MASK
+      b ^= rot(a, 19)
+      a = (a + c) & UINT32_MASK
+      c = (c - b) & UINT32_MASK
+      c ^= rot(b, 4)
+      b = (b + a) & UINT32_MASK
+      [a, b, c]
+    end
+
+    # Corresponds to final(a, b, c) macro in hashfn.c
+    def self.final(state)
+      a, b, c = state
+      c ^= b
+      c = (c - rot(b, 14)) & UINT32_MASK
+      a ^= c
+      a = (a - rot(c, 11)) & UINT32_MASK
+      b ^= a
+      b = (b - rot(a, 25)) & UINT32_MASK
+      c ^= b
+      c = (c - rot(b, 16)) & UINT32_MASK
+      a ^= c
+      a = (a - rot(c, 4)) & UINT32_MASK
+      b ^= a
+      b = (b - rot(a, 14)) & UINT32_MASK
+      c ^= b
+      c = (c - rot(b, 24)) & UINT32_MASK
+      [a, b, c]
+    end
+
+    # Corresponds to hash_bytes_uint32_extended(uint32 k, uint64 seed)
+    # This implementation is based on analysis of specific PostgreSQL code paths
+    # related to partitioning, and may differ slightly from a general lookup3 implementation.
+    def self.hash_uint32_extended(key_value, seed)
+      key_value &= UINT32_MASK
+      seed &= UINT64_MASK
+
+      initval = 0x9e3779b9 + 4 + 3_923_095
+      a = b = c = initval & UINT32_MASK
+
+      # Perturb state with seed parts and mix if seed is non-zero
+      if seed != 0
+        a = (a + (seed >> 32)) & UINT32_MASK
+        b = (b + (seed & UINT32_MASK)) & UINT32_MASK
+        a, b, c = mix([a, b, c])
+      end
+
+      a = (a + key_value) & UINT32_MASK
+      _, b, c = final([a, b, c])
+
+      (((b.to_i << 32) | c.to_i) & UINT64_MASK)
+    end
+
+    # Corresponds to hashint8extended(int64 val, uint64 seed) logic
+    def self.hashint8extended(value:, seed:)
+      val = value.to_i
+      seed &= UINT64_MASK
+
+      val_masked64 = val & UINT64_MASK
+      lohalf = (val_masked64 & UINT32_MASK)
+      hihalf = ((val_masked64 >> 32) & UINT32_MASK)
+
+      val_int64 = val_masked64 > 0x7FFFFFFFFFFFFFFF ? (val_masked64 - (1 << 64)) : val_masked64
+      is_positive_or_zero_int64 = (val_int64 >= 0)
+
+      lohalf ^= if is_positive_or_zero_int64
+                  hihalf
+                else
+                  (~hihalf & UINT32_MASK)
+                end
+
+      hash_uint32_extended(lohalf, seed)
+    end
+
+    # Corresponds to hashint4extended(int32 val, uint64 seed) logic
+    def self.hashint4extended(value:, seed:)
+      val32 = value.to_i & UINT32_MASK
+      hash_uint32_extended(val32, seed & UINT64_MASK)
+    end
+
+    # Calculates the target partition index for a given bigint value.
+    def self.calculate_partition_index_bigint(value:, seed:, magic_constant:, num_partitions:)
+      raise ArgumentError, "Number of partitions must be positive" unless num_partitions.positive?
+
+      hash_val = hashint8extended(value: value, seed: seed)
+
+      result = (hash_val + magic_constant) & UINT64_MASK
+      idx = result % num_partitions
+      idx.to_i
+    end
+
+    # Calculates the target partition index for a given int4 value.
+    def self.calculate_partition_index_int4(value:, seed:, magic_constant:, num_partitions:)
+      raise ArgumentError, "Number of partitions must be positive" unless num_partitions.positive?
+
+      hash_val = hashint4extended(value: value, seed: seed)
+
+      result = (hash_val + magic_constant) & UINT64_MASK
+      idx = result % num_partitions
+      idx.to_i
+    end
+  end
+end

data/lib/pg_hash_func/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PgHashFunc
+  VERSION = "0.1.0"
+end

data/lib/pg_hash_func.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative "pg_hash_func/version"
+require_relative "pg_hash_func/hasher"
+
+# Module providing functions to replicate PostgreSQL's bigint hash partitioning logic.
+module PgHashFunc
+  class Error < StandardError; end
+
+  # Provides functions to replicate PostgreSQL's bigint hash partitioning logic.
+
+  # Expose the raw hash function (`hashint8extended`) if needed.
+  # This is the core PostgreSQL hash function for bigint values.
+  #
+  # @param value [Integer] The integer value to hash.
+  # @param seed [Integer] The 64-bit seed. Defaults to PostgreSQL's standard HASH_PARTITION_SEED.
+  # @return [Integer] The 64-bit hash result (as a Ruby Integer).
+  def self.hashint8extended(value:, seed: Hasher::HASH_PARTITION_SEED)
+    Hasher.hashint8extended(value: value, seed: seed)
+  end
+
+  # Calculates the target partition index for a given bigint (int8) value based on
+  # PostgreSQL's default hash partitioning strategy.
+  # Mimics (hashint8extended(value, seed) + magic) % num_partitions using uint64 arithmetic.
+  #
+  # @param value [Integer] The partitioning key value (treated as bigint).
+  # @param num_partitions [Integer] The number of partitions for this level.
+  # @param seed [Integer] The 64-bit seed. Defaults to PostgreSQL's standard HASH_PARTITION_SEED.
+  # @param magic_constant [Integer] The magic constant. Defaults to PostgreSQL's standard PARTITION_MAGIC_CONSTANT.
+  # @return [Integer] The calculated partition index (0-based).
+  def self.calculate_partition_index_bigint(value:, num_partitions:, seed: Hasher::HASH_PARTITION_SEED,
+                                            magic_constant: Hasher::PARTITION_MAGIC_CONSTANT)
+    Hasher.calculate_partition_index_bigint(value: value, seed: seed, magic_constant: magic_constant,
+                                            num_partitions: num_partitions)
+  end
+
+  # Calculates the target partition index for a given integer (int4) or smallint (int2) value based on
+  # PostgreSQL's default hash partitioning strategy.
+  # Mimics (hashint4extended(value, seed) + magic) % num_partitions using uint64 arithmetic.
+  # Note: PostgreSQL uses the same hash function (`hashint4extended` equivalent) for both int2 and int4.
+  #
+  # @param value [Integer] The partitioning key value (treated as int4/int2).
+  # @param num_partitions [Integer] The number of partitions for this level.
+  # @param seed [Integer] The 64-bit seed. Defaults to PostgreSQL's standard HASH_PARTITION_SEED.
+  # @param magic_constant [Integer] The magic constant. Defaults to PostgreSQL's standard PARTITION_MAGIC_CONSTANT.
+  # @return [Integer] The calculated partition index (0-based).
+  def self.calculate_partition_index_int4(value:, num_partitions:, seed: Hasher::HASH_PARTITION_SEED,
+                                          magic_constant: Hasher::PARTITION_MAGIC_CONSTANT)
+    Hasher.calculate_partition_index_int4(value: value, seed: seed, magic_constant: magic_constant,
+                                          num_partitions: num_partitions)
+  end
+end

data/pg_hash_func.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "lib/pg_hash_func/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pg_hash_func"
+  spec.version       = PgHashFunc::VERSION
+  spec.authors       = ["Shayon Mukherjee"]
+  spec.email         = ["shayonj@gmail.com"]
+
+  spec.summary       = "Determine the target partition index for an integer key according " \
+                       "to PostgreSQL's default hash strategy, without querying the database."
+  spec.description   = <<~DESC
+    Replicates PostgreSQL's default hash partitioning calculations.
+    Specifically targets the logic within `hashint8extended` (for bigint)
+    and `hashint4extended` (for integer/smallint) from PostgreSQL's
+    `src/backend/access/hash/hashfunc.c`.
+  DESC
+  spec.homepage      = "https://github.com/shayonj/pg_hash_func"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/shayonj/pg_hash_func"
+    spec.metadata["changelog_uri"] = "https://github.com/shayonj/pg_hash_func/blob/main/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+          "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

data/scripts/release.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+set -euo pipefail
+
+export VERSION=$1
+echo "VERSION: ${VERSION}"
+
+echo "=== Building Gem ===="
+gem build pg_hash_func.gemspec
+
+echo "=== Pushing gem ===="
+gem push pg_hash_func-"$VERSION".gem
+
+echo "=== Sleeping for 15s ===="
+sleep 15
+
+echo "=== Pushing tags to github ===="
+git tag v"$VERSION"
+git push origin --tags
+
+echo "=== Cleaning up ===="
+rm pg_hash_func-"$VERSION".gem

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: pg_hash_func
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shayon Mukherjee
+bindir: exe
+cert_chain: []
+date: 2025-04-26 00:00:00.000000000 Z
+dependencies: []
+description: |
+  Replicates PostgreSQL's default hash partitioning calculations.
+  Specifically targets the logic within `hashint8extended` (for bigint)
+  and `hashint4extended` (for integer/smallint) from PostgreSQL's
+  `src/backend/access/hash/hashfunc.c`.
+email:
+- shayonj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmarks/file.rb
+- lib/pg_hash_func.rb
+- lib/pg_hash_func/hasher.rb
+- lib/pg_hash_func/version.rb
+- pg_hash_func.gemspec
+- scripts/release.sh
+homepage: https://github.com/shayonj/pg_hash_func
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/shayonj/pg_hash_func
+  source_code_uri: https://github.com/shayonj/pg_hash_func
+  changelog_uri: https://github.com/shayonj/pg_hash_func/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.6
+specification_version: 4
+summary: Determine the target partition index for an integer key according to PostgreSQL's
+  default hash strategy, without querying the database.
+test_files: []