mirror of
https://github.com/firebase/firebase-ios-sdk
synced 2026-11-11 22:55:59 +05:45
Greg Soltis
5d38a3512d
* Start work on leveldb transactions
* Style
* Working API. Not plumbed in yet
* Move files into correct place
* Wrangling file locations and associations
* Tests pass
* Add some comments
* style
* Fix copyright
* Rewrite iterator internals to handle deletion-while-iterating. Also add tests for same
* Switch to strings instead of slices
* Style
* More style fixes
* Start switching writegroup over
* Swap out write group tracking for transaction usage
* Style
* Response to feedback before updating docs
* Style
* Add comment
* Initialize version_
* Satisfy the linter
* Start switching writegroup over
* Swap out write group tracking for transaction usage
* Style
* Checkpoint before implementing BatchDescription
* Style
* Initial plumbing for leveldb local parts
* Add model::BatchId
* Port leveldb_key.{h,cc}
* Add string StartsWith
* Add leveldb_key_test.cc to the project
* Revert back to using leveldb::Slice for read/describe
These operations universally operate on keys obtained from leveldb so
it's actually unhelpful to force all the callers to make
absl::string_views from them.
* Everything passing
* Drop unused function
* Style
* STart work on reads
* Swap reads in queryCache to use transactions
* Fix up tests of querycache
* Drop commented out code
* Cleanup
* Style
* Fix up for passing tests
* style
* Renaming
* Style
* Start work on ToString for transactions
* Add ToString() method to LevelDbTransaction
* Style
* lint
* Fix includes, drop runTransaction
* current_transaction -> currentTransaction
* LevelDbTransaction::NewIterator now returns a unique_ptr
* Style
* Revert addition of util::StartsWith
* Add log line
* Style
* Add log line
* Style
* Add debug log line for commits, drop unused BatchDescription
* STart work on reads
* Swap reads in queryCache to use transactions
* Start on remote documents
* Transition mutation queue and remote documents to use transactions
* Style
* Make everything pass
* Make everything pass
* Make it compile
* Style
* Style
* Revert name change, use DefaultReadOptions()
* Style
* Example of running a transaction with a lambda
* Drop errant typo
* Drop duplicate method declarations
* replace usage of auto w/ decltype
* Drop an unnecessary _Nullable. Add some nullability warning suppression
* use absl::make_unique, handle void return type
* Style
* Wrap backing persistence and expectation of backing persistence for transaction runner into a method
* More comments, trigger CI
105 lines
4.0 KiB
Objective-C
105 lines
4.0 KiB
Objective-C
/*
|
|
* Copyright 2017 Google
|
|
*
|
|
* Licensed 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.
|
|
*/
|
|
|
|
#import <Foundation/Foundation.h>
|
|
|
|
#include <memory>
|
|
|
|
#import "Firestore/Source/Local/FSTPersistence.h"
|
|
#include "Firestore/core/src/firebase/firestore/core/database_info.h"
|
|
#include "Firestore/core/src/firebase/firestore/local/leveldb_transaction.h"
|
|
#include "leveldb/db.h"
|
|
|
|
@class FSTLocalSerializer;
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/** A LevelDB-backed instance of FSTPersistence. */
|
|
// TODO(mikelehen): Rename to FSTLevelDBPersistence.
|
|
@interface FSTLevelDB : NSObject <FSTPersistence, FSTTransactional>
|
|
|
|
/**
|
|
* Initializes the LevelDB in the given directory. Note that all expensive startup work including
|
|
* opening any database files is deferred until -[FSTPersistence start] is called.
|
|
*/
|
|
- (instancetype)initWithDirectory:(NSString *)directory
|
|
serializer:(FSTLocalSerializer *)serializer NS_DESIGNATED_INITIALIZER;
|
|
|
|
- (instancetype)init __attribute__((unavailable("Use -initWithDirectory: instead.")));
|
|
|
|
/** Finds a suitable directory to serve as the root of all Firestore local storage. */
|
|
+ (NSString *)documentsDirectory;
|
|
|
|
/**
|
|
* Computes a unique storage directory for the given identifying components of local storage.
|
|
*
|
|
* @param databaseInfo The identifying information for the local storage instance.
|
|
* @param documentsDirectory The root document directory relative to which the storage directory
|
|
* will be created. Usually just +[FSTLevelDB documentsDir].
|
|
* @return A storage directory unique to the instance identified by databaseInfo.
|
|
*/
|
|
+ (NSString *)storageDirectoryForDatabaseInfo:
|
|
(const firebase::firestore::core::DatabaseInfo &)databaseInfo
|
|
documentsDirectory:(NSString *)documentsDirectory;
|
|
|
|
/**
|
|
* Starts LevelDB-backed persistent storage by opening the database files, creating the DB if it
|
|
* does not exist.
|
|
*
|
|
* The leveldb directory is created relative to the appropriate document storage directory for the
|
|
* platform: NSDocumentDirectory on iOS or $HOME/.firestore on macOS.
|
|
*/
|
|
- (BOOL)start:(NSError **)error;
|
|
|
|
// What follows is the Objective-C++ extension to the API.
|
|
/**
|
|
* @return A standard set of read options
|
|
*/
|
|
+ (const leveldb::ReadOptions)standardReadOptions;
|
|
|
|
/**
|
|
* Creates an NSError based on the given status if the status is not ok.
|
|
*
|
|
* @param status The status of the preceding LevelDB operation.
|
|
* @param description A printf-style format string describing what kind of failure happened if
|
|
* @a status is not ok. Additional parameters are substituted into the placeholders in this
|
|
* format string.
|
|
*
|
|
* @return An NSError with its localizedDescription composed from the description format and its
|
|
* localizedFailureReason composed from any error message embedded in @a status.
|
|
*/
|
|
+ (nullable NSError *)errorWithStatus:(leveldb::Status)status
|
|
description:(NSString *)description, ... NS_FORMAT_FUNCTION(2, 3);
|
|
|
|
/**
|
|
* Converts the given @a status to an NSString describing the status condition, suitable for
|
|
* logging or inclusion in an NSError.
|
|
*
|
|
* @param status The status of the preceding LevelDB operation.
|
|
*
|
|
* @return An NSString describing the status (even if the status was ok).
|
|
*/
|
|
+ (NSString *)descriptionOfStatus:(leveldb::Status)status;
|
|
|
|
/** The native db pointer, allocated during start. */
|
|
@property(nonatomic, assign, readonly) std::shared_ptr<leveldb::DB> ptr;
|
|
|
|
@property(nonatomic, readonly) firebase::firestore::local::LevelDbTransaction *currentTransaction;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|