Skip to content

Materialize PG::Tuple objects when freezing and undef PG::Tuple.new #770

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
larskanis merged 2 commits into from
Nov 9, 2026
Merged

Materialize PG::Tuple objects when freezing and undef PG::Tuple.new #770

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc52811
Undefine PG::Tuple.new since it has no use at all
larskanis Nov 7, 2026
6dfc948
Materialize PG::Tuple objects when freezing
larskanis Nov 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions ext/pg_tuple.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -547,14 +547,30 @@ pg_tuple_load(VALUE self, VALUE a)
return self;
}

/*
* call-seq:
* res.freeze
*
* Freeze the PG::Tuple object and materialize all fields, so that it can be safely shared across ractors.
*
*/
static VALUE
pg_tuple_freeze(VALUE self)
{
pg_tuple_materialize(self);
return rb_call_super(0, NULL);
}

void
init_pg_tuple(void)
{
rb_cPG_Tuple = rb_define_class_under( rb_mPG, "Tuple", rb_cObject );
rb_define_alloc_func( rb_cPG_Tuple, pg_tuple_s_allocate );
rb_undef_method(rb_singleton_class(rb_cPG_Tuple), "new");
rb_include_module(rb_cPG_Tuple, rb_mEnumerable);

rb_define_method(rb_cPG_Tuple, "fetch", pg_tuple_fetch, -1);
rb_define_method(rb_cPG_Tuple, "freeze", pg_tuple_freeze, 0 );
rb_define_method(rb_cPG_Tuple, "[]", pg_tuple_aref, 1);
rb_define_method(rb_cPG_Tuple, "each", pg_tuple_each, 0);
rb_define_method(rb_cPG_Tuple, "each_value", pg_tuple_each_value, 0);
Expand Down
18 changes: 6 additions & 12 deletions spec/pg/tuple_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,12 @@
let!(:tuple2) { result2x3cast.tuple(0).freeze }
let!(:tuple2sym) { result2x3symcast.tuple(0).freeze }
let!(:tuple3) { str = Marshal.dump(result2x3cast.tuple(1).freeze); Marshal.load(str) }
let!(:tuple_empty) { PG::Tuple.new.freeze }

describe "new" do
it "is not defined" do
expect { PG::Tuple.new }.to raise_error(NoMethodError)
end
end

describe "[]" do
it "returns nil for invalid keys" do
Expand All @@ -35,7 +40,6 @@
expect( tuple0[2] ).to be_nil
expect( tuple0[-3] ).to be_nil
expect( tuple2[-4] ).to be_nil
expect{ tuple_empty[0] }.to raise_error(TypeError)
end

it "supports array like access" do
Expand Down Expand Up @@ -114,7 +118,6 @@
expect{ tuple0.fetch(-3) }.to raise_error(IndexError)
expect{ tuple0.fetch(-3) }.to raise_error(IndexError)
expect{ tuple2.fetch(-4) }.to raise_error(IndexError)
expect{ tuple_empty[0] }.to raise_error(TypeError)
end

it "supports array like access" do
Expand Down Expand Up @@ -158,7 +161,6 @@
expect( tuple1.each.to_a ).to eq( [["column1", "2"], ["column2", "b"]] )
expect( tuple2.each.to_a ).to eq( [["a", 1], ["b", true], ["b", "3"]] )
expect( tuple3.each.to_a ).to eq( [["a", 2], ["b", false], ["b", "4"]] )
expect{ tuple_empty.each }.to raise_error(TypeError)
end

it "can be used as an enumerator with symbols" do
Expand All @@ -183,7 +185,6 @@
expect( tuple1.each_value.to_a ).to eq( ["2", "b"] )
expect( tuple2.each_value.to_a ).to eq( [1, true, "3"] )
expect( tuple3.each_value.to_a ).to eq( [2, false, "4"] )
expect{ tuple_empty.each_value }.to raise_error(TypeError)
end

it "can be used with block" do
Expand All @@ -198,7 +199,6 @@
it "responds to values" do
expect( tuple0.values ).to eq( ["1", "a"] )
expect( tuple3.values ).to eq( [2, false, "4"] )
expect{ tuple_empty.values }.to raise_error(TypeError)
end

it "responds to key?" do
Expand Down Expand Up @@ -294,10 +294,6 @@
expect( t2.instance_variable_get("@a") ).to eq( 4711 )
end

it "can't be marshaled when empty" do
expect{ Marshal.dump(tuple_empty) }.to raise_error(TypeError)
end

it "should be shareable for Ractor", :ractor do
res = @conn.exec("SELECT 1").tuple(0)
Ractor.make_shareable(res)
Expand All @@ -322,14 +318,12 @@

it "should give account about memory usage" do
expect( ObjectSpace.memsize_of(tuple0) ).to be > DATA_OBJ_MEMSIZE
expect( ObjectSpace.memsize_of(tuple_empty) ).to be > 0
end

it "should override #inspect" do
expect( tuple1.inspect ).to eq('#<PG::Tuple column1: "2", column2: "b">')
expect( tuple2.inspect ).to eq('#<PG::Tuple a: 1, b: true, b: "3">')
expect( tuple2sym.inspect ).to eq('#<PG::Tuple a: 1, b: true, b: "3">')
expect{ tuple_empty.inspect }.to raise_error(TypeError)
end

context "with cleared result" do
Expand Down
Loading