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
//! Add data by means of a new transaction.
use crate::write::Writer;
use std::io::{Seek, Write};
use std::path::{Path, PathBuf};
/// Create a transaction file in the specified db directory.
///
/// Add new records with [`CreateTx::add_record`]. They must be
/// in sorted order.
///
/// After adding records, call [`CreateTx::commit`] which ensures
/// the transaction is on disk. Not calling commit will
/// rollback the transaction.
pub struct CreateTx {
writer: Writer<std::fs::File>,
tmp: tempfile_fast::PersistableTempFile,
dir: PathBuf,
}
impl CreateTx {
/// Open a transaction file inside this specific directory.
///
/// The transaction is named "tx.XXX.tmp" where XXX is an
/// increasing value basedo on timestamp.
///
/// On commit, the file is renamed to not have the ".tmp"
/// suffix.
pub fn new(dir: &Path) -> std::io::Result<CreateTx> {
let tmp = tempfile_fast::PersistableTempFile::new_in(dir)?;
let f = tmp.try_clone()?;
let writer = Writer::new(f);
let tx = CreateTx {
writer,
tmp,
dir: dir.to_owned(),
};
Ok(tx)
}
/// Add a record with the given key, timestamp, and values.
///
/// The values can be encoded with the function [`crate::record()`]
///
/// The format string is automatically inferred by the Rust-types of the values.
/// ```no_run
/// # let mut transaction = sonnerie::CreateTx::new(std::path::Path::new("")).unwrap();
/// transaction.add_record(
/// "key name",
/// "2010-01-01T00:00:01".parse().unwrap(),
/// sonnerie::record("Column 1").add("Column 2").add(3i32)
/// ).unwrap();
/// ```
///
/// Because &[&dyn ToRecord] also implements the [`crate::RecordBuilder`] trait,
/// you can also use an array to specify the types, but then less work happens at compile-time
/// and the performance isn't as good:
/// ```no_run
/// # let mut transaction = sonnerie::CreateTx::new(std::path::Path::new("")).unwrap();
/// transaction.add_record(
/// "key name",
/// "2010-01-01T00:00:01".parse().unwrap(),
/// &[&"Column 1" as &dyn sonnerie::ToRecord, &"Column 2", &3i32]
/// ).unwrap();
/// ```
///
/// Each successive call to this function must have greater
/// or equal values for key and timestamp.
pub fn add_record(
&mut self,
key: &str,
timestamp: chrono::NaiveDateTime,
values: impl crate::RecordBuilder,
) -> std::result::Result<(), crate::WriteFailure> {
self.writer.add_record(
key,
timestamp
.timestamp_nanos_opt()
.ok_or(crate::WriteFailure::UnableToParseTimestamp)? as crate::Timestamp,
values,
)
}
/// Add a record with the given key, format, and payload.
///
/// The data must match the format (otherwise you can corrupt
/// the database). The data also encodes the timestamp.
///
/// Each successive call to this function must have greater
/// or equal values for key and timestamp.
///
/// Encode the data with [`crate::row_format::RowFormat`].
///
/// This function is made available for tools that need more versaility
/// in how they process databases. It's generally preferable to use [`CreateTx::add_record()`]
pub fn add_record_raw(
&mut self,
key: &str,
format: &str,
data: &[u8],
) -> std::result::Result<(), crate::write::WriteFailure> {
self.writer.add_record_raw(key, format, data)
}
/// Delete a range of records
///
/// You can use an empty string to indicate "unbounded" and `u64::MIN` and `u64::MAX`
/// for the timestamps, similarly.
///
/// This function must be called as the one and only action in a transaction
/// and then committed.
pub fn delete(
&mut self,
first_key: &str,
last_key: &str,
after_time: u64,
before_time: u64,
filter: &str,
) -> std::result::Result<(), crate::write::WriteFailure> {
use core::ops::IndexMut as _;
use crate::row_format::{Element as _, ElementString};
use byteorder::{BigEndian, ByteOrder as _};
// write row format
let key = first_key;
let format = "\u{007f}";
let mut row_data = Vec::with_capacity(
first_key.as_bytes().len()
+ filter.as_bytes().len()
+ last_key.as_bytes().len()
+ 16 // length of two u64's
+ 27 // practical maximum length of three varints
+ 1, // the format
);
// bypass RowFormat entirely, we're going to be building row_data here
// so we don't get to pass str values
// write first key
ElementString
.to_stored_format(first_key, &mut row_data)
.unwrap();
// write first timestamp
row_data.extend_from_slice(&[0; 8]);
BigEndian::write_u64(
row_data.index_mut(row_data.len() - 8..row_data.len()),
after_time,
);
// write last timestamp
row_data.extend_from_slice(&[0; 8]);
BigEndian::write_u64(
row_data.index_mut(row_data.len() - 8..row_data.len()),
before_time,
);
// write key wildcard
ElementString
.to_stored_format(filter, &mut row_data)
.unwrap();
// write last key
ElementString
.to_stored_format(last_key, &mut row_data)
.unwrap();
self.writer.add_record_raw(key, format, &row_data)
}
/// Commit the transaction, but give it a specific name.
///
/// This function is necessary for compacting, normally
/// you would just call the basic [`CreateTx::commit`].
pub fn commit_to(self, final_name: &Path) -> std::io::Result<()> {
let writer = self.writer;
let mut file = writer.finish()?;
file.flush()?;
let len = file.seek(std::io::SeekFrom::End(0))? as usize;
if len == 0 {
// don't create an empty transaction file
drop(file);
if final_name.file_name().map(|n| n == "main") != Some(true) {
let _ = std::fs::remove_file(final_name);
}
return Ok(());
}
file.sync_all()?;
drop(file);
self.tmp
.persist_by_rename(final_name)
.map_err(|e| e.error)?;
if let Some(umask) = get_umask() {
use std::os::unix::fs::PermissionsExt;
let p = std::fs::Permissions::from_mode(0o444 & !umask);
let _ = std::fs::set_permissions(final_name, p);
}
Ok(())
}
/// Commit the transaction.
///
/// On successful completion, the data is on disk (fsync is called)
/// and the filename is renamed to lose its ".tmp" suffix.
pub fn commit(self) -> std::io::Result<()> {
{
// maybe we can just replace `main`
let mainpath = self.dir.join("main");
let maininfo = std::fs::metadata(&mainpath)?;
if maininfo.len() == 0 {
use fs2::FileExt;
// ok, try again, this time having locked the db
let lock = std::fs::File::create(self.dir.join(".compact"))?;
lock.lock_exclusive()?;
let maininfo = std::fs::metadata(&mainpath)?;
if maininfo.len() == 0 {
// now, with a lock, `main` is still 0 bytes, so
// we can safely replace it
return self.commit_to(&mainpath);
}
}
}
for attempt in 0.. {
let timestamp: i64 = std::time::SystemTime::now()
.duration_since(std::time::SystemTime::UNIX_EPOCH)
.expect("duration_since epoch")
.as_nanos()
.try_into()
.map_err(|e| std::io::Error::new(std::io::ErrorKind::Other, e))?;
let n = format!("tx.{:016x}", timestamp);
let final_name = self.dir.join(n);
let f = std::fs::OpenOptions::new()
.write(true)
.create_new(true)
.open(&final_name);
match f {
Ok(_) => {
if let Err(e) = self.commit_to(&final_name) {
eprintln!("failure committing {:?}", final_name);
return Err(e);
} else {
return Ok(());
}
}
Err(e) if e.kind() == std::io::ErrorKind::AlreadyExists => {
if attempt == 1000 {
return Err(e);
}
std::thread::sleep(std::time::Duration::from_millis(100 * attempt));
continue;
}
Err(e) => return Err(e),
}
}
unreachable!();
}
}
fn get_umask() -> Option<libc::mode_t> {
let s = std::fs::read_to_string("/proc/self/status").ok()?;
for line in s.split('\n') {
if let Some(line) = line.strip_prefix("Umask:") {
let line = line.trim();
return libc::mode_t::from_str_radix(line, 8).ok();
}
}
None
}