user/dev discussion of public-inbox itself
 help / color / mirror / Atom feed
From: Eric Wong <e@yhbt.net>
To: meta@public-inbox.org
Subject: [PATCH 1/5] over: rename ->connect method to ->dbh
Date: Wed, 26 Aug 2020 08:17:38 +0000
Message-ID: <20200826081742.16642-2-e@yhbt.net> (raw)
In-Reply-To: <20200826081742.16642-1-e@yhbt.net>

`->connect' is confused with the perlfunc for the `connect(2)'
syscall, and also `DBI->connect'.  Since SQLite doesn't use
sockets, the word "connect" needlessly confuses me.  Give
it a short name to match the field name we use for it, which
also matches the variable name used by the DBI(3pm) and
DBD::SQLite(3pm) manpages.
---
 lib/PublicInbox/Inbox.pm   |  2 +-
 lib/PublicInbox/Over.pm    | 19 +++++++++----------
 lib/PublicInbox/OverIdx.pm |  4 ++--
 lib/PublicInbox/Xapcmd.pm  |  2 +-
 scripts/dupe-finder        |  2 +-
 t/over.t                   |  9 ++++-----
 t/search-thr-index.t       |  4 ++--
 t/v1reindex.t              |  2 +-
 t/v2reindex.t              |  2 +-
 9 files changed, 22 insertions(+), 24 deletions(-)

diff --git a/lib/PublicInbox/Inbox.pm b/lib/PublicInbox/Inbox.pm
index 55e546e1..241001d3 100644
--- a/lib/PublicInbox/Inbox.pm
+++ b/lib/PublicInbox/Inbox.pm
@@ -211,7 +211,7 @@ sub over ($) {
 	my $srch = search($self, 1) or return;
 	$self->{over} //= eval {
 		my $over = $srch->{over_ro};
-		$over->connect; # may fail
+		$over->dbh; # may fail
 		$over;
 	}
 }
diff --git a/lib/PublicInbox/Over.pm b/lib/PublicInbox/Over.pm
index 3e74b7a6..0ebc8003 100644
--- a/lib/PublicInbox/Over.pm
+++ b/lib/PublicInbox/Over.pm
@@ -80,7 +80,7 @@ sub disconnect {
 	}
 }
 
-sub connect { $_[0]->{dbh} //= $_[0]->dbh_new }
+sub dbh ($) { $_[0]->{dbh} //= $_[0]->dbh_new } # dbh_new may be subclassed
 
 sub load_from_row ($;$) {
 	my ($smsg, $cull) = @_;
@@ -97,10 +97,9 @@ sub load_from_row ($;$) {
 
 sub do_get {
 	my ($self, $sql, $opts, @args) = @_;
-	my $dbh = $self->connect;
 	my $lim = (($opts->{limit} || 0) + 0) || DEFAULT_LIMIT;
 	$sql .= "LIMIT $lim";
-	my $msgs = $dbh->selectall_arrayref($sql, { Slice => {} }, @args);
+	my $msgs = dbh($self)->selectall_arrayref($sql, { Slice => {} }, @args);
 	my $cull = $opts->{cull};
 	load_from_row($_, $cull) for @$msgs;
 	$msgs
@@ -135,7 +134,7 @@ sub nothing () { wantarray ? (0, []) : [] };
 
 sub get_thread {
 	my ($self, $mid, $prev) = @_;
-	my $dbh = $self->connect;
+	my $dbh = dbh($self);
 	my $opts = { cull => 1 };
 
 	my $id = $dbh->selectrow_array(<<'', undef, $mid);
@@ -202,7 +201,7 @@ ORDER BY $sort_col DESC
 # returns true if we have IDs, undef if not
 sub expand_thread {
 	my ($self, $ctx) = @_;
-	my $dbh = $self->connect;
+	my $dbh = dbh($self);
 	do {
 		defined(my $num = $ctx->{ids}->[0]) or return;
 		my ($tid) = $dbh->selectrow_array(<<'', undef, $num);
@@ -259,7 +258,7 @@ SELECT COUNT(num) FROM over WHERE num > 0
 sub get_art {
 	my ($self, $num) = @_;
 	# caching $sth ourselves is faster than prepare_cached
-	my $sth = $self->{-get_art} //= $self->connect->prepare(<<'');
+	my $sth = $self->{-get_art} //= dbh($self)->prepare(<<'');
 SELECT num,tid,ds,ts,ddd FROM over WHERE num = ? LIMIT 1
 
 	$sth->execute($num);
@@ -269,7 +268,7 @@ SELECT num,tid,ds,ts,ddd FROM over WHERE num = ? LIMIT 1
 
 sub next_by_mid {
 	my ($self, $mid, $id, $prev) = @_;
-	my $dbh = $self->connect;
+	my $dbh = dbh($self);
 
 	unless (defined $$id) {
 		my $sth = $dbh->prepare_cached(<<'', undef, 1);
@@ -293,7 +292,7 @@ ORDER BY num ASC LIMIT 1
 # IMAP search, this is limited by callers to UID_SLICE size (50K)
 sub uid_range {
 	my ($self, $beg, $end, $sql) = @_;
-	my $dbh = $self->connect;
+	my $dbh = dbh($self);
 	my $q = 'SELECT num FROM over WHERE num >= ? AND num <= ?';
 
 	# This is read-only, anyways; but caller should verify it's
@@ -305,7 +304,7 @@ sub uid_range {
 
 sub max {
 	my ($self) = @_;
-	my $sth = $self->connect->prepare_cached(<<'', undef, 1);
+	my $sth = dbh($self)->prepare_cached(<<'', undef, 1);
 SELECT MAX(num) FROM over WHERE num > 0
 
 	$sth->execute;
@@ -314,7 +313,7 @@ SELECT MAX(num) FROM over WHERE num > 0
 
 sub imap_exists {
 	my ($self, $uid_base, $uid_end) = @_;
-	my $sth = $self->connect->prepare_cached(<<'', undef, 1);
+	my $sth = dbh($self)->prepare_cached(<<'', undef, 1);
 SELECT COUNT(num) FROM over WHERE num > ? AND num <= ?
 
 	$sth->execute($uid_base, $uid_end);
diff --git a/lib/PublicInbox/OverIdx.pm b/lib/PublicInbox/OverIdx.pm
index 9f4a56fb..c521464a 100644
--- a/lib/PublicInbox/OverIdx.pm
+++ b/lib/PublicInbox/OverIdx.pm
@@ -443,7 +443,7 @@ sub commit_lazy {
 sub begin_lazy {
 	my ($self) = @_;
 	return if $self->{txn};
-	my $dbh = $self->connect or return;
+	my $dbh = $self->dbh or return;
 	$dbh->begin_work;
 	# $dbh->{Profile} = 2;
 	$self->{txn} = 1;
@@ -469,7 +469,7 @@ sub create {
 		File::Path::mkpath(File::Basename::dirname($self->{filename}));
 	}
 	# create the DB:
-	PublicInbox::Over::connect($self);
+	PublicInbox::Over::dbh($self);
 	$self->disconnect;
 }
 
diff --git a/lib/PublicInbox/Xapcmd.pm b/lib/PublicInbox/Xapcmd.pm
index fffac99c..6a74daf9 100644
--- a/lib/PublicInbox/Xapcmd.pm
+++ b/lib/PublicInbox/Xapcmd.pm
@@ -37,7 +37,7 @@ sub commit_changes ($$$$) {
 			defined $new or die "BUG: $over exists when culling v2";
 			$over = PublicInbox::Over->new($over);
 			my $tmp_over = "$new/over.sqlite3";
-			$over->connect->sqlite_backup_to_file($tmp_over);
+			$over->dbh->sqlite_backup_to_file($tmp_over);
 			$over = undef;
 			$over_chg = 1;
 		}
diff --git a/scripts/dupe-finder b/scripts/dupe-finder
index 6f873b6e..04714cbd 100644
--- a/scripts/dupe-finder
+++ b/scripts/dupe-finder
@@ -21,7 +21,7 @@ if (index($repo, '@') > 0) {
 }
 $ibx or die "No inbox";
 $ibx->search or die "search not available for inbox";
-my $dbh = $ibx->search->{over_ro}->connect;
+my $dbh = $ibx->search->{over_ro}->dbh;
 my $over = PublicInbox::Over->new($dbh->sqlite_db_filename);
 
 sub emit ($) {
diff --git a/t/over.t b/t/over.t
index 8bf64ecb..6c4c8ee6 100644
--- a/t/over.t
+++ b/t/over.t
@@ -9,7 +9,7 @@ require_mods('DBD::SQLite');
 use_ok 'PublicInbox::OverIdx';
 my ($tmpdir, $for_destroy) = tmpdir();
 my $over = PublicInbox::OverIdx->new("$tmpdir/over.sqlite3");
-$over->connect;
+$over->dbh; # open file
 is($over->max, 0, 'max is zero on new DB (scalar context)');
 is_deeply([$over->max], [0], 'max is zero on new DB (list context)');
 my $x = $over->next_tid;
@@ -26,11 +26,10 @@ ok(!$over->{dbh}->{ReadOnly}, 'OverIdx is not ReadOnly');
 $over->disconnect;
 
 $over = PublicInbox::Over->new("$tmpdir/over.sqlite3");
-$over->connect;
-ok($over->{dbh}->{ReadOnly}, 'Over is ReadOnly');
+ok($over->dbh->{ReadOnly}, 'Over is ReadOnly');
 
 $over = PublicInbox::OverIdx->new("$tmpdir/over.sqlite3");
-$over->connect;
+$over->dbh;
 is($over->sid('hello-world'), $x, 'idempotent across reopen');
 $over->each_by_mid('never', sub { fail('should not be called') });
 
@@ -71,7 +70,7 @@ SKIP: {
 	skip("no WAL in SQLite version $v < 3.7.0", 1) if $v lt v3.7.0;
 	$over->{dbh}->do('PRAGMA journal_mode = WAL');
 	$over = PublicInbox::OverIdx->new("$tmpdir/over.sqlite3");
-	is($over->connect->selectrow_array('PRAGMA journal_mode'), 'wal',
+	is($over->dbh->selectrow_array('PRAGMA journal_mode'), 'wal',
 		'WAL journal_mode not clobbered if manually set');
 }
 
diff --git a/t/search-thr-index.t b/t/search-thr-index.t
index 914807a8..b5a5ff1f 100644
--- a/t/search-thr-index.t
+++ b/t/search-thr-index.t
@@ -60,7 +60,7 @@ foreach (reverse split(/\n\n/, $data)) {
 
 my $prev;
 my %tids;
-my $dbh = $rw->{over}->connect;
+my $dbh = $rw->{over}->dbh;
 foreach my $mid (@mids) {
 	my $msgs = $rw->{over}->get_thread($mid);
 	is(3, scalar(@$msgs), "got all messages from $mid");
@@ -84,7 +84,7 @@ Message-Id: <1-bw@g>
 From: bw@g
 To: git@vger.kernel.org
 
-	my $dbh = $rw->{over}->connect;
+	my $dbh = $rw->{over}->dbh;
 	my ($id, $prev);
 	my $reidx = $rw->{over}->next_by_mid('1-bw@g', \$id, \$prev);
 	ok(defined $reidx);
diff --git a/t/v1reindex.t b/t/v1reindex.t
index d70ed4b9..a5c85ffb 100644
--- a/t/v1reindex.t
+++ b/t/v1reindex.t
@@ -434,7 +434,7 @@ ok(!-d $xap, 'Xapian directories removed again');
 	my $ibx = PublicInbox::Inbox->new({ %$ibx_config });
 	my $f = $ibx->over->{dbh}->sqlite_db_filename;
 	my $over = PublicInbox::OverIdx->new($f);
-	my $dbh = $over->connect;
+	my $dbh = $over->dbh;
 	my $non_ghost_tids = sub {
 		$dbh->selectall_arrayref(<<'');
 SELECT tid FROM over WHERE num > 0 ORDER BY tid ASC
diff --git a/t/v2reindex.t b/t/v2reindex.t
index ea2b24e5..a2fc2075 100644
--- a/t/v2reindex.t
+++ b/t/v2reindex.t
@@ -432,7 +432,7 @@ my $check_rethread = sub {
 	my $ibx = PublicInbox::Inbox->new(\%config);
 	my $f = $ibx->over->{dbh}->sqlite_db_filename;
 	my $over = PublicInbox::OverIdx->new($f);
-	my $dbh = $over->connect;
+	my $dbh = $over->dbh;
 	my $non_ghost_tids = sub {
 		$dbh->selectall_arrayref(<<'');
 SELECT tid FROM over WHERE num > 0 ORDER BY tid ASC

  reply	other threads:[~2020-08-26  8:17 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-08-26  8:17 [PATCH 0/5] some minor SQLite-related cleanups Eric Wong
2020-08-26  8:17 ` Eric Wong [this message]
2020-08-26  8:17 ` [PATCH 2/5] over: rename ->disconnect to ->dbh_close Eric Wong
2020-08-26  8:17 ` [PATCH 3/5] over: recent: remove expensive COUNT query Eric Wong
2020-08-26  8:17 ` [PATCH 4/5] over*: use v5.10.1, drop warnings Eric Wong
2020-08-26  8:17 ` [PATCH 5/5] msgmap: use v5.10.1 Eric Wong

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://public-inbox.org/README

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200826081742.16642-2-e@yhbt.net \
    --to=e@yhbt.net \
    --cc=meta@public-inbox.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

user/dev discussion of public-inbox itself

This inbox may be cloned and mirrored by anyone:

	git clone --mirror https://public-inbox.org/meta
	git clone --mirror http://czquwvybam4bgbro.onion/meta
	git clone --mirror http://hjrcffqmbrq6wope.onion/meta
	git clone --mirror http://ou63pmih66umazou.onion/meta

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V1 meta meta/ https://public-inbox.org/meta \
		meta@public-inbox.org
	public-inbox-index meta

Example config snippet for mirrors.
Newsgroups are available over NNTP:
	nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta
	nntp://ou63pmih66umazou.onion/inbox.comp.mail.public-inbox.meta
	nntp://czquwvybam4bgbro.onion/inbox.comp.mail.public-inbox.meta
	nntp://hjrcffqmbrq6wope.onion/inbox.comp.mail.public-inbox.meta
	nntp://news.gmane.io/gmane.mail.public-inbox.general
 note: .onion URLs require Tor: https://www.torproject.org/

code repositories for the project(s) associated with this inbox:

	https://80x24.org/public-inbox.git

AGPL code for this site: git clone https://public-inbox.org/public-inbox.git