Xuanwo commented on code in PR #6328: URL: https://github.com/apache/opendal/pull/6328#discussion_r2199961392
########## core/src/services/sqlite/lister.rs: ########## @@ -0,0 +1,181 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +use crate::raw::build_rel_path; +use crate::raw::oio; +use crate::services::sqlite::core::SqliteCore; +use crate::{EntryMode, Metadata}; +use futures::StreamExt; +use std::sync::Arc; + +pub struct SqliteLister { + root: String, + iter: Box<dyn Iterator<Item = crate::Result<String>> + Send + Sync>, + iter_to_end: bool, +} + +impl SqliteLister { + pub async fn new( + core: Arc<SqliteCore>, + path: &str, + root: String, + options: crate::raw::OpList, + ) -> crate::Result<Self> { + let path_clean = path.trim_end_matches('/'); + + // Build SQL query based on path and recursive flag + let (query, bindings) = if path.is_empty() || path == "/" { + // Root path listing + if options.recursive() { + // Return all entries + ( + format!("SELECT `{}` FROM `{}`", core.key_field, core.table), + vec![], + ) + } else { + // Return only top-level entries + (format!( + "SELECT `{}` FROM `{}` WHERE `{}` NOT LIKE '%/%' OR (`{}` LIKE '%/' AND `{}` NOT LIKE '%/%/')", + core.key_field, core.table, core.key_field, core.key_field, core.key_field + ), vec![]) + } + } else if !path.ends_with('/') && !options.recursive() { + // Path without trailing slash: could be a file or directory + // First check if it exists as a file + let file_exists: i64 = sqlx::query_scalar(&format!( + "SELECT COUNT(*) FROM `{}` WHERE `{}` = $1", + core.table, core.key_field + )) + .bind(path_clean) + .fetch_one(core.get_client().await?) + .await + .map_err(crate::services::sqlite::backend::parse_sqlite_error)?; + + if file_exists > 0 { + // Return the file itself + return Ok(Self { + root, + iter_to_end: false, + iter: Box::new(vec![Ok(path_clean.to_string())].into_iter()), + }); + } + + // Check if it exists as a directory + let dir_exists: i64 = sqlx::query_scalar(&format!( + "SELECT COUNT(*) FROM `{}` WHERE `{}` LIKE $1", + core.table, core.key_field + )) + .bind(format!("{path_clean}/%")) + .fetch_one(core.get_client().await?) + .await + .map_err(crate::services::sqlite::backend::parse_sqlite_error)?; + + if dir_exists > 0 { + // Return the directory itself + return Ok(Self { + root, + iter_to_end: false, + iter: Box::new(vec![Ok(format!("{path_clean}/"))].into_iter()), + }); + } + // Check for prefix matches (for compatibility with prefix-based listing) + let prefix_results: Vec<crate::Result<String>> = sqlx::query_scalar(&format!( + "SELECT `{}` FROM `{}` WHERE `{}` LIKE $1 AND `{}` NOT LIKE '%/%'", + core.key_field, core.table, core.key_field, core.key_field + )) + .bind(format!("{path_clean}%")) + .fetch(core.get_client().await?) + .map(|v| v.map_err(crate::services::sqlite::backend::parse_sqlite_error)) + .collect::<Vec<_>>() + .await; + if !prefix_results.is_empty() { + // Return prefix matches + return Ok(Self { + root, + iter_to_end: false, + iter: Box::new(prefix_results.into_iter()), + }); + } else { + // No matches found + return Ok(Self { + root, + iter_to_end: false, + iter: Box::new(vec![].into_iter()), + }); + } + } else if options.recursive() { + // Recursive listing under a specific path + ( + format!( + "SELECT `{}` FROM `{}` WHERE `{}` LIKE $1 OR `{}` = $2", + core.key_field, core.table, core.key_field, core.key_field + ), + vec![format!("{}%", path), format!("{}/", path_clean)], + ) + } else { + // Non-recursive listing under a specific path + (format!( + "SELECT `{}` FROM `{}` WHERE (`{}` LIKE $1 OR `{}` = $2) AND (`{}` NOT LIKE $3 OR (`{}` LIKE $4 AND `{}` NOT LIKE $5))", Review Comment: Should we just use something like ```sql SELECT key FROM objects WHERE key GLOB 'a/*' AND key NOT GLOB 'a/*/*'; ``` ########## core/src/services/sqlite/backend.rs: ########## @@ -170,158 +164,208 @@ impl Builder for SqliteBuilder { } } -pub type SqliteBackend = kv::Backend<Adapter>; - -#[derive(Debug, Clone)] -pub struct Adapter { - pool: OnceCell<SqlitePool>, - config: SqliteConnectOptions, +pub fn parse_sqlite_error(err: sqlx::Error) -> Error { + let is_temporary = matches!( + &err, + sqlx::Error::Database(db_err) if db_err.code().is_some_and(|c| c == "5" || c == "6") + ); - table: String, - key_field: String, - value_field: String, -} + let message = if is_temporary { + "database is locked or busy" + } else { + "unhandled error from sqlite" + }; -impl Adapter { - async fn get_client(&self) -> Result<&SqlitePool> { - self.pool - .get_or_try_init(|| async { - let pool = SqlitePool::connect_with(self.config.clone()) - .await - .map_err(parse_sqlite_error)?; - Ok(pool) - }) - .await + let mut error = Error::new(ErrorKind::Unexpected, message).set_source(err); + if is_temporary { + error = error.set_temporary(); } + error } -#[self_referencing] -pub struct SqliteScanner { - pool: SqlitePool, - query: String, - - #[borrows(pool, query)] - #[covariant] - stream: BoxStream<'this, Result<String>>, +/// SqliteAccessor implements Access trait directly +#[derive(Debug, Clone)] +pub struct SqliteAccessor { + core: std::sync::Arc<SqliteCore>, + root: String, + info: std::sync::Arc<AccessorInfo>, } -impl Stream for SqliteScanner { - type Item = Result<String>; +impl SqliteAccessor { + fn new(core: SqliteCore) -> Self { + let info = AccessorInfo::default(); + info.set_scheme(Scheme::Sqlite); + info.set_name(&core.table); + info.set_root("/"); + info.set_native_capability(Capability { + read: true, + write: true, + delete: true, + stat: true, + write_can_empty: true, + list: true, + shared: false, + list_with_recursive: true, + ..Default::default() + }); + + Self { + core: std::sync::Arc::new(core), + root: "/".to_string(), + info: std::sync::Arc::new(info), + } + } - fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> { - self.with_stream_mut(|s| s.poll_next_unpin(cx)) + fn with_normalized_root(mut self, root: String) -> Self { + self.info.set_root(&root); + self.root = root; + self } } -unsafe impl Sync for SqliteScanner {} +impl Access for SqliteAccessor { + type Reader = Buffer; + type Writer = SqliteWriter; + type Lister = SqliteLister; + type Deleter = oio::OneShotDeleter<SqliteDeleter>; -impl kv::Scan for SqliteScanner { - async fn next(&mut self) -> Result<Option<String>> { - <Self as StreamExt>::next(self).await.transpose() + fn info(&self) -> std::sync::Arc<AccessorInfo> { + self.info.clone() } -} -impl kv::Adapter for Adapter { - type Scanner = SqliteScanner; - - fn info(&self) -> kv::Info { - kv::Info::new( - Scheme::Sqlite, - &self.table, - Capability { - read: true, - write: true, - delete: true, - list: true, - shared: false, - ..Default::default() - }, - ) + async fn stat(&self, path: &str, _: OpStat) -> Result<RpStat> { + let p = build_abs_path(&self.root, path); + + if p == build_abs_path(&self.root, "") { + Ok(RpStat::new(Metadata::new(EntryMode::DIR))) + } else { + let bs = self.core.get(&p).await?; + match bs { + Some(bs) => Ok(RpStat::new( + Metadata::new(EntryMode::from_path(&p)).with_content_length(bs.len() as u64), + )), + None => Err(Error::new(ErrorKind::NotFound, "key not found in sqlite")), + } + } } - async fn get(&self, path: &str) -> Result<Option<Buffer>> { - let pool = self.get_client().await?; + async fn read(&self, path: &str, args: OpRead) -> Result<(RpRead, Self::Reader)> { + let p = build_abs_path(&self.root, path); - let value: Option<Vec<u8>> = sqlx::query_scalar(&format!( - "SELECT `{}` FROM `{}` WHERE `{}` = $1 LIMIT 1", - self.value_field, self.table, self.key_field - )) - .bind(path) - .fetch_optional(pool) - .await - .map_err(parse_sqlite_error)?; + let range = args.range(); + let buffer = if range.is_full() { + // Full read - use GET + match self.core.get(&p).await? { + Some(bs) => bs, + None => return Err(Error::new(ErrorKind::NotFound, "key not found in sqlite")), + } + } else { + // Range read - use GETRANGE + let start = range.offset() as isize; + let limit = match range.size() { + Some(size) => size as isize, + None => -1, // Sqlite uses -1 for end of string + }; + + match self.core.get_range(&p, start, limit).await? { + Some(bs) => bs, + None => return Err(Error::new(ErrorKind::NotFound, "key not found in sqlite")), + } + }; - Ok(value.map(Buffer::from)) + Ok((RpRead::new(), buffer)) } - async fn set(&self, path: &str, value: Buffer) -> Result<()> { - let pool = self.get_client().await?; + async fn write(&self, path: &str, _: OpWrite) -> Result<(RpWrite, Self::Writer)> { + let p = build_abs_path(&self.root, path); + Ok((RpWrite::new(), SqliteWriter::new(self.core.clone(), &p))) + } - sqlx::query(&format!( - "INSERT OR REPLACE INTO `{}` (`{}`, `{}`) VALUES ($1, $2)", - self.table, self.key_field, self.value_field, + async fn delete(&self) -> Result<(RpDelete, Self::Deleter)> { + Ok(( + RpDelete::default(), + oio::OneShotDeleter::new(SqliteDeleter::new(self.core.clone(), self.root.clone())), )) - .bind(path) - .bind(value.to_vec()) - .execute(pool) - .await - .map_err(parse_sqlite_error)?; - - Ok(()) } - async fn delete(&self, path: &str) -> Result<()> { - let pool = self.get_client().await?; - - sqlx::query(&format!( - "DELETE FROM `{}` WHERE `{}` = $1", - self.table, self.key_field + async fn list(&self, path: &str, options: OpList) -> Result<(RpList, Self::Lister)> { + let path = build_abs_path(&self.root, path); + Ok(( + RpList::default(), + SqliteLister::new(self.core.clone(), &path, self.root.clone(), options).await?, )) - .bind(path) - .execute(pool) - .await - .map_err(parse_sqlite_error)?; + } +} + +#[cfg(test)] +mod test { + use super::*; + use sqlx::SqlitePool; - Ok(()) + async fn build_client() -> OnceCell<SqlitePool> { + let file = tempfile::NamedTempFile::new().unwrap(); + let config = SqliteConnectOptions::from_str(file.path().to_str().unwrap()).unwrap(); + let pool = SqlitePool::connect_with(config).await.unwrap(); + OnceCell::new_with(Some(pool)) } - async fn scan(&self, path: &str) -> Result<Self::Scanner> { - let pool = self.get_client().await?; - let stream = SqliteScannerBuilder { - pool: pool.clone(), - query: format!( - "SELECT `{}` FROM `{}` WHERE `{}` LIKE $1", - self.key_field, self.table, self.key_field - ), - stream_builder: |pool, query| { - sqlx::query_scalar(query) - .bind(format!("{path}%")) - .fetch(pool) - .map(|v| v.map_err(parse_sqlite_error)) - .boxed() - }, - } - .build(); + #[tokio::test] + async fn test_sqlite_accessor_creation() { + let core = SqliteCore { + pool: build_client().await, + config: Default::default(), + table: "test".to_string(), + key_field: "key".to_string(), + value_field: "value".to_string(), + }; - Ok(stream) + let accessor = SqliteAccessor::new(core); + + // Verify basic properties + assert_eq!(accessor.root, "/"); + assert_eq!(accessor.info.scheme(), Scheme::Sqlite); + assert!(accessor.info.native_capability().read); + assert!(accessor.info.native_capability().write); + assert!(accessor.info.native_capability().delete); + assert!(accessor.info.native_capability().stat); } -} -fn parse_sqlite_error(err: sqlx::Error) -> Error { - let is_temporary = matches!( - &err, - sqlx::Error::Database(db_err) if db_err.code().is_some_and(|c| c == "5" || c == "6") - ); + #[tokio::test] + async fn test_sqlite_accessor_with_root() { + let core = SqliteCore { + pool: build_client().await, + config: Default::default(), + table: "test".to_string(), + key_field: "key".to_string(), + value_field: "value".to_string(), + }; - let message = if is_temporary { - "database is locked or busy" - } else { - "unhandled error from sqlite" - }; + let accessor = SqliteAccessor::new(core).with_normalized_root("/test/".to_string()); - let mut error = Error::new(ErrorKind::Unexpected, message).set_source(err); - if is_temporary { - error = error.set_temporary(); + assert_eq!(accessor.root, "/test/"); + assert_eq!(accessor.info.root(), "/test/".into()); + } + + #[test] + fn test_sqlite_builder_interface() { Review Comment: Those tests are meaningless. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: commits-unsubscr...@opendal.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
