1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
|
#include "catch.hpp"
#include "test_helpers.hpp"
#include "duckdb/main/db_instance_cache.hpp"
#include "duckdb/storage/storage_extension.hpp"
#include "duckdb/transaction/duck_transaction_manager.hpp"
#include "duckdb/catalog/duck_catalog.hpp"
#include "duckdb/common/local_file_system.hpp"
#include <chrono>
#include <iostream>
#include <thread>
using namespace duckdb;
static void background_thread_connect(DBInstanceCache *instance_cache, std::string *path) {
try {
DBConfig config;
auto connection = instance_cache->GetOrCreateInstance(*path, config, true);
connection.reset();
} catch (std::exception &ex) {
FAIL(ex.what());
}
}
TEST_CASE("Test parallel connection and destruction of connections with database instance cache", "[api][.]") {
DBInstanceCache instance_cache;
for (idx_t i = 0; i < 100; i++) {
auto path = TestCreatePath("instance_cache_parallel.db");
DBConfig config;
auto shared_db = instance_cache.GetOrCreateInstance(path, config, true);
std::thread background_thread(background_thread_connect, &instance_cache, &path);
shared_db.reset();
background_thread.join();
TestDeleteFile(path);
REQUIRE(1);
}
}
struct DelayingStorageExtension : StorageExtension {
DelayingStorageExtension() {
attach = [](optional_ptr<StorageExtensionInfo>, ClientContext &, AttachedDatabase &db, const string &,
AttachInfo &info, AttachOptions &) -> unique_ptr<Catalog> {
std::this_thread::sleep_for(std::chrono::seconds(5));
return make_uniq_base<Catalog, DuckCatalog>(db);
};
create_transaction_manager = [](optional_ptr<StorageExtensionInfo>, AttachedDatabase &db,
Catalog &) -> unique_ptr<TransactionManager> {
return make_uniq<DuckTransactionManager>(db);
};
}
};
TEST_CASE("Test db creation does not block instance cache", "[api][.]") {
DBInstanceCache instance_cache;
using namespace std::chrono;
auto second_creation_was_quick = false;
shared_ptr<DuckDB> stick_around;
std::thread t1 {[&instance_cache, &second_creation_was_quick, &stick_around]() {
DBConfig db_config;
StorageExtension::Register(db_config, "delay", make_shared_ptr<DelayingStorageExtension>());
stick_around = instance_cache.GetOrCreateInstance("delay::memory:", db_config, true);
const auto start_time = steady_clock::now();
for (idx_t i = 0; i < 10; i++) {
StorageExtension::Register(db_config, "delay", make_shared_ptr<DelayingStorageExtension>());
instance_cache.GetOrCreateInstance("delay::memory:", db_config, true);
}
const auto end_time = steady_clock::now();
second_creation_was_quick = duration_cast<seconds>(end_time - start_time).count() < 5;
}};
std::this_thread::sleep_for(seconds(2));
auto opening_slow_db_takes_remaining_time = false;
std::thread t2 {[&instance_cache, &opening_slow_db_takes_remaining_time]() {
DBConfig db_config;
const auto start_time = steady_clock::now();
instance_cache.GetOrCreateInstance("delay::memory:", db_config, true);
const auto end_time = steady_clock::now();
const auto duration = duration_cast<milliseconds>(end_time - start_time);
opening_slow_db_takes_remaining_time = duration > seconds(1) && duration < seconds(10);
}};
auto no_delay_for_db_creation = true;
std::thread t3 {[&instance_cache, &no_delay_for_db_creation]() {
const auto start_time = steady_clock::now();
DBConfig db_config;
while (start_time + seconds(3) < steady_clock::now()) {
auto db_start_time = steady_clock::now();
instance_cache.GetOrCreateInstance(":memory:", db_config, false);
no_delay_for_db_creation &= duration_cast<milliseconds>(steady_clock::now() - db_start_time).count() < 1000;
}
}};
t1.join();
t2.join();
t3.join();
if (!second_creation_was_quick) {
REQUIRE("second_creation_was_quick" == nullptr);
}
if (!opening_slow_db_takes_remaining_time) {
REQUIRE("opening_slow_db_takes_remaining_time" == nullptr);
}
if (!no_delay_for_db_creation) {
REQUIRE("no_delay_for_db_creation" == nullptr);
}
}
TEST_CASE("Test attaching the same database path from different databases", "[api][.]") {
DBInstanceCache instance_cache;
auto test_path = TestCreatePath("instance_cache_reuse.db");
DBConfig config;
auto db1 = instance_cache.GetOrCreateInstance(":memory:", config, false);
auto db2 = instance_cache.GetOrCreateInstance(":memory:", config, false);
Connection con1(*db1);
Connection con2(*db2);
SECTION("Regular ATTACH conflict") {
string attach_query = "ATTACH '" + test_path + "' AS db_ref";
REQUIRE_NO_FAIL(con1.Query(attach_query));
// fails - already attached in db1
REQUIRE_FAIL(con2.Query(attach_query));
// if we detach from con1, we can now attach in con2
REQUIRE_NO_FAIL(con1.Query("DETACH db_ref"));
REQUIRE_NO_FAIL(con2.Query(attach_query));
// .. but not in con1 anymore!
REQUIRE_FAIL(con1.Query(attach_query));
}
SECTION("ATTACH IF NOT EXISTS") {
string attach_query = "ATTACH IF NOT EXISTS '" + test_path + "' AS db_ref";
REQUIRE_NO_FAIL(con1.Query(attach_query));
// fails - already attached in db1
REQUIRE_FAIL(con2.Query(attach_query));
}
}
TEST_CASE("Test attaching the same database path from different databases in read-only mode", "[api][.]") {
DBInstanceCache instance_cache;
auto test_path = TestCreatePath("instance_cache_reuse_readonly.db");
// create an empty database
{
DuckDB db(test_path);
Connection con(db);
REQUIRE_NO_FAIL(con.Query("CREATE TABLE IF NOT EXISTS integers AS FROM (VALUES (1), (2), (3)) t(i)"));
}
DBConfig config;
auto db1 = instance_cache.GetOrCreateInstance(":memory:", config, false);
auto db2 = instance_cache.GetOrCreateInstance(":memory:", config, false);
auto db3 = instance_cache.GetOrCreateInstance(":memory:", config, false);
Connection con1(*db1);
Connection con2(*db2);
Connection con3(*db3);
SECTION("Regular ATTACH conflict") {
string attach_query = "ATTACH '" + test_path + "' AS db_ref";
string read_only_attach = attach_query + " (READ_ONLY)";
REQUIRE_NO_FAIL(con1.Query(read_only_attach));
// succeeds - we can attach the same database multiple times in read-only mode
REQUIRE_NO_FAIL(con2.Query(read_only_attach));
// fails - we cannot attach in read-write
REQUIRE_FAIL(con3.Query(attach_query));
// if we detach from con1, we still cannot attach in read-write in con3
REQUIRE_NO_FAIL(con1.Query("DETACH db_ref"));
REQUIRE_FAIL(con3.Query(attach_query));
// but if we detach in con2, we can attach in read-write mode now
REQUIRE_NO_FAIL(con2.Query("DETACH db_ref"));
REQUIRE_NO_FAIL(con3.Query(attach_query));
// and now we can no longer attach in read-only mode
REQUIRE_FAIL(con1.Query(read_only_attach));
}
SECTION("ATTACH IF EXISTS") {
string attach_query = "ATTACH IF NOT EXISTS '" + test_path + "' AS db_ref";
string read_only_attach = attach_query + " (READ_ONLY)";
REQUIRE_NO_FAIL(con1.Query(read_only_attach));
// succeeds - we can attach the same database multiple times in read-only mode
REQUIRE_NO_FAIL(con2.Query(read_only_attach));
// fails - we cannot attach in read-write
REQUIRE_FAIL(con3.Query(attach_query));
// if we detach from con1, we still cannot attach in read-write in con3
REQUIRE_NO_FAIL(con1.Query("DETACH db_ref"));
REQUIRE_FAIL(con3.Query(attach_query));
// but if we detach in con2, we can attach in read-write mode now
REQUIRE_NO_FAIL(con2.Query("DETACH db_ref"));
REQUIRE_NO_FAIL(con3.Query(attach_query));
// and now we can no longer attach in read-only mode
REQUIRE_FAIL(con1.Query(read_only_attach));
}
}
TEST_CASE("Test instance cache canonicalization", "[api][.]") {
LocalFileSystem fs;
DBInstanceCache instance_cache;
vector<string> equivalent_paths;
auto test_path = TestCreatePath("instance_cache_canonicalization.db");
// base path
equivalent_paths.push_back(test_path);
// abs path
equivalent_paths.push_back(fs.JoinPath(fs.GetWorkingDirectory(), test_path));
// dot dot
auto dot_dot = TestCreatePath(fs.JoinPath("subdir", "..", "instance_cache_canonicalization.db"));
equivalent_paths.push_back(dot_dot);
// dot dot dot
auto subdirs = fs.JoinPath("subdir", "subdir2", "subdir3", "..", "..", "..", "instance_cache_canonicalization.db");
auto dot_dot_dot = TestCreatePath(subdirs);
equivalent_paths.push_back(dot_dot_dot);
// dots
auto dots = TestCreatePath(fs.JoinPath(fs.JoinPath(".", "."), "instance_cache_canonicalization.db"));
equivalent_paths.push_back(dots);
// dots that point to a real directory
auto test_dir_path = TestDirectoryPath();
auto sep = fs.PathSeparator(test_dir_path);
idx_t dir_count = StringUtil::Split(test_dir_path, sep).size();
string many_dots_test_path = test_dir_path;
for (idx_t i = 0; i < dir_count; i++) {
many_dots_test_path = fs.JoinPath(many_dots_test_path, "..");
}
equivalent_paths.push_back(fs.JoinPath(many_dots_test_path, test_dir_path, "instance_cache_canonicalization.db"));
vector<shared_ptr<DuckDB>> databases;
for (auto &path : equivalent_paths) {
DBConfig config;
auto db = instance_cache.GetOrCreateInstance(path, config, true);
databases.push_back(std::move(db));
}
{
Connection con(*databases[0]);
REQUIRE_NO_FAIL(con.Query("CREATE TABLE tbl AS SELECT 42 i"));
}
// verify that all these databases point to the same path
for (auto &db : databases) {
Connection con(*db);
auto result = con.Query("SELECT * FROM tbl");
REQUIRE(CHECK_COLUMN(*result, 0, {42}));
}
}
TEST_CASE("Test database file path manager absolute path", "[api][.]") {
LocalFileSystem fs;
DuckDB db;
Connection con(db);
auto test_db = TestCreatePath("test_same_db_attach.db");
auto test_db_abs = fs.JoinPath(fs.GetWorkingDirectory(), test_db);
// we can attach this once
REQUIRE_NO_FAIL(con.Query("ATTACH '" + test_db + "' AS db1"));
// we cannot attach with absolute path, even though our original attach was with relative path
REQUIRE_FAIL(con.Query("ATTACH '" + test_db_abs + "' AS db2"));
// after detaching we can attach with absolute path
REQUIRE_NO_FAIL(con.Query("DETACH db1"));
REQUIRE_NO_FAIL(con.Query("ATTACH '" + test_db_abs + "' AS db2"));
}
TEST_CASE("Test automatic DB instance caching", "[api][.]") {
DBInstanceCache instance_cache;
DBConfig config;
SECTION("Unnamed in-memory connections are not shared") {
auto db1 = instance_cache.GetOrCreateInstance(":memory:", config);
auto db2 = instance_cache.GetOrCreateInstance(":memory:", config);
Connection con(*db1);
Connection con2(*db2);
REQUIRE_NO_FAIL(con.Query("CREATE TABLE t(i INT)"));
REQUIRE_NO_FAIL(con2.Query("CREATE TABLE t(i INT)"));
}
SECTION("Named in-memory connections are shared") {
auto db1 = instance_cache.GetOrCreateInstance(":memory:abc", config);
auto db2 = instance_cache.GetOrCreateInstance(":memory:abc", config);
Connection con(*db1);
Connection con2(*db2);
REQUIRE_NO_FAIL(con.Query("CREATE TABLE t(i INT)"));
REQUIRE_NO_FAIL(con2.Query("SELECT * FROM t"));
}
}
|