5.0.0-alpha2

.github/README.md

@@ -0,0 +1,2 @@
+# .github
+

README.md

@@ -87,7 +87,7 @@ Add artifacts to your project:
 
  // Android Architecture Components Paging Library Support
  implementation "com.github.agrosner.dbflow:paging:${dbflow_version}"
- 
+
  // Android Architecture Components LiveData Library Support
  implementation "com.github.agrosner.dbflow:livedata:${dbflow_version}"
 

SUMMARY.md

@@ -17,15 +17,15 @@
  * [TypeConverters](usage2/usage/typeconverters.md)
  * [Observability](usage2/usage/observability.md)
  * [RXJavaSupport](usage2/rxjavasupport.md)
- * [Advanced Usage](usage2/advanced-usage/README.md)
- * [Caching](usage2/advanced-usage/caching.md)
- * [ListBasedQueries](usage2/advanced-usage/listbasedqueries.md)
- * [MultipleModules](usage2/advanced-usage/multiplemodules.md)
- * [QueryModels](usage2/advanced-usage/querymodels.md)
- * [Indexing](usage2/advanced-usage/indexing.md)
- * [SQLCipher](usage2/advanced-usage/sqlciphersupport.md)
  * [ContentProviderGeneration](usage2/contentprovidergeneration.md)
  * [Migration4Guide](usage2/migration4guide.md)
+* [Advanced Usage](advanced-usage/README.md)
+ * [Caching](advanced-usage/caching.md)
+ * [List Queries](advanced-usage/listbasedqueries.md)
+ * [Multiple Modules](advanced-usage/multiplemodules.md)
+ * [QueryModels](advanced-usage/querymodels.md)
+ * [Indexing](advanced-usage/indexing.md)
+ * [SQLCipher](advanced-usage/sqlciphersupport.md)
 * [ISSUE\_TEMPLATE](issue_template.md)
 * [.github](.github/README.md)
  * [CONTRIBUTING](.github/contributing.md)

usage2/advanced-usage/caching.md → advanced-usage/caching.md

@@ -17,8 +17,8 @@ Do not use caching when: 1. you need a subset of columns from the DB. i.e. \(`se
 
 ## Clearing Caches
 
-Sometimes the data becomes out of sync, or you perform a vanilla SQLite query, which causes data to get out of sync from the cache. In those cases
-call:
+Sometimes the data becomes out of sync, or you perform a vanilla SQLite query, which causes data to get out of sync from the cache. In those cases call:
+
 ```kotlin
 modelAdapter<MyTable>().cacheAdapter.clearCache()
 ```
@@ -110,3 +110,4 @@ class Coordinate(@PrimaryKey latitude: Double = 0.0,
 ```
 
 In this case we use the `IMultiKeyCacheConverter` class, which specifies a key type that the object returns. The `getCachingKey` method returns an ordered set of `@PrimaryKey` columns in declaration order. Also the value that is returned should have an `equals()` or `hashcode()` specified \(use a `data class`\) especially when used in the `SimpleMapCache`.
+

usage2/advanced-usage/indexing.md → advanced-usage/indexing.md

@@ -6,7 +6,7 @@ In SQLite, an `Index` is a pointer to specific columns in a table that enable su
 
 Indexes are defined using the `indexGroups()` property of the `@Table` annotation. These operate similar to how `UniqueGroup` work: 1. specify an `@IndexGroup` 2. Add the `@Index` 3. Build and an `IndexProperty` gets generated. This allows super-easy access to the index so you can enable/disable it with ease.
 
-**Note**: `Index` are not explicitly enabled unless coupled with an `IndexMigration`. \([read here](../usage/migrations.md#index-migrations)\).
+**Note**: `Index` are not explicitly enabled unless coupled with an `IndexMigration`. \([read here](../usage2/usage/migrations.md#index-migrations)\).
 
 You can define as many `@IndexGroup` you want within a `@Table` as long as one field references the group. Also individual `@Column` can belong to any number of groups:
 
@@ -63,3 +63,4 @@ index.createIfNotExists(database)
 
 index.drop(database)
 ```
+

usage2/advanced-usage/listbasedqueries.md → advanced-usage/listbasedqueries.md

@@ -1,8 +1,7 @@
-# ListBasedQueries
+# List Queries
 
 Converting a whole list at one chunk can be memory intensive. This lazily creates models from a `Cursor` for you and you can operate on it s if it's a list. It a acts like a list can be used in a for-loop:
 
-
 ```kotlin
 (select from MyTable::class
  where ...) // some conditions
@@ -21,7 +20,6 @@ Converting a whole list at one chunk can be memory intensive. This lazily create
 
  list.forEach { printLn("$it") }
  }
-
 ```
 
 **Note**: It's preferred within a `RecyclerView` to use the `QueryDataSource` with the Paging library, as this use can potentially lock the UI thread during heavy db usage.
@@ -43,3 +41,4 @@ The `FlowCursorList` provides these methods:
 This class is a much more powerful version of the `FlowCursorList`. It contains a `FlowCursorList`, which backs it's retrieval operations.
 
 This class acts as `List` and can be used almost wherever a `List` is used.
+

usage2/advanced-usage/multiplemodules.md → advanced-usage/multiplemodules.md

@@ -1,11 +1,10 @@
-# MultipleModules
+# Multiple Modules
 
 In apps that want to share DBFlow across multiple modules or when developing a library module that uses DBFlow, we have to provide a little extra configuration to properly ensure that all database classes are accounted for.
 
 It's directly related to the fact that annotation processors are isolated between projects and are not shared.
 
-In order to add support for multiple modules, in each and every library/subproject that uses a DBFlow instance, 
-you must add an annotation processing argument to its `build.gradle`:
+In order to add support for multiple modules, in each and every library/subproject that uses a DBFlow instance, you must add an annotation processing argument to its `build.gradle`:
 
 Using KAPT:
 
@@ -17,6 +16,7 @@ kapt {
  }
 }
 ```
+
 or if you use Android/Java:
 
 ```java
@@ -28,12 +28,9 @@ javaCompileOptions {
  }
 ```
 
-By passing the targetModuleName, we append that to the `GeneratedDatabaseHolder` class name to create the `{targetModuleName}GeneratedDatabaseHolder` module.
- **Note**: Specifying this in code means you need to specify the module when initializing DBFlow:
+By passing the targetModuleName, we append that to the `GeneratedDatabaseHolder` class name to create the `{targetModuleName}GeneratedDatabaseHolder` module. **Note**: Specifying this in code means you need to specify the module when initializing DBFlow:
 
-From previous sample code, we recommend initializing the specific module inside your library, 
-to prevent developer error. **Note**: Multiple calls to `FlowManager` will not adversely affect DBFlow. 
-If DBFlow is already initialized, we append the module to DBFlow if and only if it does not already exist.
+From previous sample code, we recommend initializing the specific module inside your library, to prevent developer error. **Note**: Multiple calls to `FlowManager` will not adversely affect DBFlow. If DBFlow is already initialized, we append the module to DBFlow if and only if it does not already exist.
 
 ```kotlin
 fun initialize(context: Context) {
@@ -42,3 +39,4 @@ fun initialize(context: Context) {
  .build())
 }
 ```
+

usage2/advanced-usage/querymodels.md → advanced-usage/querymodels.md

@@ -50,17 +50,13 @@ And adjust our query to handle the new output:
  .execute { transaction, list ->
  // utilize list
  }
-
 ```
 
 ## Query Model Support
 
 `QueryModel` are read-only. We can only retrieve from DB into a cursor.
 
-They support inheritance and visibility modifiers as defined by [Models](../usage/models.md).
+They support inheritance and visibility modifiers as defined by [Models](../usage2/usage/models.md).
+
+`QueryModel` **do not** support: 1. `InheritedField`/`InheritedPrimaryKey` 2. `@PrimaryKey`/`@ForeignKey` 3. direct caching. 4. changing "useBooleanGetterSetters" for private boolean fields.
 
-`QueryModel` **do not** support:
- 1. `InheritedField`/`InheritedPrimaryKey`
- 2. `@PrimaryKey`/`@ForeignKey`
- 3. direct caching.
- 4. changing "useBooleanGetterSetters" for private boolean fields.

gettingstarted.md

@@ -1,4 +1,4 @@
-# Getting Started
+# GettingStarted
 
 This section describes how Models and tables are constructed via DBFlow. first let's describe how to get a database up and running.
 
@@ -19,10 +19,7 @@ public abstract class AppDatabase extends DBFlowDatabase {
 
 The name of the database by default is the class name. To change it, read [here](usage2/usage/databases.md).
 
-Writing this file generates \(by default\) a `AppDatabaseAppDatabase_Database.java` file, which contains tables, views, and more all tied to a specific database.
- This class is automatically placed into the main `GeneratedDatabaseHolder`,
- which holds potentially many databases.
- The name, `AppDatabaseAppDatabase_Database.java`, is generated via {DatabaseClassName}{DatabaseFileName}\_Database
+Writing this file generates \(by default\) a `AppDatabaseAppDatabase_Database.java` file, which contains tables, views, and more all tied to a specific database. This class is automatically placed into the main `GeneratedDatabaseHolder`, which holds potentially many databases. The name, `AppDatabaseAppDatabase_Database.java`, is generated via {DatabaseClassName}{DatabaseFileName}\_Database
 
 To learn more about what you can configure in a database, read [here](usage2/usage/databases.md)
 
@@ -100,7 +97,7 @@ You can define different kinds for each database. To read more on transactions a
 
 Creating models are as simple as defining the model class, and adding the `@Table` annotation. To read more on this, read [here](usage2/usage/models.md).
 
-**For now**: Models must provide a default, parameterless constructor. Also, all fields must be mutable (currently, we hope to evolve this requirement in the near future). An example:
+**For now**: Models must provide a default, parameterless constructor. Also, all fields must be mutable \(currently, we hope to evolve this requirement in the near future\). An example:
 
 ```kotlin
 @Table(database = TestDatabase::class)
@@ -142,12 +139,11 @@ public class Currency {
 
 ## Build Your DAO
 
-Set up a DAO (Data Access Object) to help you interact with your database. Using dependency injection and service locating, we can build better, highly testable code. While not required to use DBFlow, it is __highly__ recommended utilize this approach.
+Set up a DAO \(Data Access Object\) to help you interact with your database. Using dependency injection and service locating, we can build better, highly testable code. While not required to use DBFlow, it is **highly** recommended utilize this approach.
 
 With kotlin, we can utilize it in a powerful way:
 
 ```kotlin
-
 /**
 * Create this class in your own database module.
 */
@@ -188,7 +184,6 @@ interface CurrencyDAO : DBProvider<AppDatabase> {
  .toDataSourceFactory(database)
 
 }
-
 ```
 
 DBFlow uses expressive builders to represent and translate to the SQLite language.
@@ -202,20 +197,18 @@ SELECT * FROM Currency WHERE symbol='$';
 Wherever we perform dependency injection we supply the instance:
 
 ```kotlin
-
 fun provideCurrencyDAO(db: AppDatabase) = object : CurrencyDAO {
  override val database: AppDatabase = db
 }
-
 ```
 
 Then in our `ViewModel`, we can inject it via the constructor and utilize it in our queries:
-```kotlin
 
+```kotlin
 class SampleViewModel(private currencyDAO: CurrencyDAO)
-
 ```
 
 We support many kinds of complex and complicated queries using the builder language. To read more about this, see [the wrapper language docs](usage2/usage/sqlitewrapperlanguage.md)
 
 There is much more you can do in DBFlow. Read through the other docs to get a sense of the library.
+

usage2/including-in-project.md

@@ -70,7 +70,7 @@ Add artifacts to your project:
 
  // Android Architecture Components Paging Library Support
  implementation "com.github.agrosner.dbflow:paging:${dbflow_version}"
- 
+
  // Android Architecture Components LiveData Library Support
  implementation "com.github.agrosner.dbflow:livedata:${dbflow_version}"
 
@@ -79,3 +79,4 @@ Add artifacts to your project:
 
  }
 ```
+

usage2/usage/databases.md

@@ -145,7 +145,7 @@ Databases can get corrupted or in an invalid state at some point. If you specify
 
 ### Custom FlowSQLiteOpenHelper
 
-For variety of reasons, you may want to provide your own `FlowSQLiteOpenHelper` to manage database interactions. To do so, you must implement `OpenHelper`, but for convenience you should extend `AndroidSQLiteOpenHelper` \(for Android databases\), or `SQLCipherOpenHelper` for SQLCipher. Read more [here](../advanced-usage/sqlciphersupport.md)
+For variety of reasons, you may want to provide your own `FlowSQLiteOpenHelper` to manage database interactions. To do so, you must implement `OpenHelper`, but for convenience you should extend `AndroidSQLiteOpenHelper` \(for Android databases\), or `SQLCipherOpenHelper` for SQLCipher. Read more [here](../../advanced-usage/sqlciphersupport.md)
 
 ```kotlin
 class CustomFlowSQliteOpenHelper(context: Contect, databaseDefinition: DatabaseDefinition, listener: DatabaseHelperListener) : FlowSQLiteOpenHelper(context, databaseDefinition, listener)

usage2/usage/migrations.md

@@ -53,14 +53,9 @@ object AppDatabase {
 }
 ```
 
-The classes provide the ability to set a `priority` on the `Migration` so that an order is 
-established if more than one migration is to run on the same DB version upgrade.
-They are in reverse order - lower the priority, that one will execute first.
+The classes provide the ability to set a `priority` on the `Migration` so that an order is established if more than one migration is to run on the same DB version upgrade. They are in reverse order - lower the priority, that one will execute first.
 
-`Migration` have three methods:
- 1. `onPreMigrate()` - called first, do setup, and construction here.
- 2. `migrate()` -> called with the `DatabaseWrapper` specified, this is where the actual migration code should execute. 
- 3. `onPostMigrate()` -> perform some cleanup, or any notifications that it was executed.
+`Migration` have three methods: 1. `onPreMigrate()` - called first, do setup, and construction here. 2. `migrate()` -> called with the `DatabaseWrapper` specified, this is where the actual migration code should execute. 3. `onPostMigrate()` -> perform some cleanup, or any notifications that it was executed.
 
 ### Migration files
 
@@ -119,7 +114,7 @@ class Migration2 : AlterTableMigration<AModel>(AModel::class.java) {
 
 ### Index Migrations
 
-An `IndexMigration` \(and `IndexPropertyMigration`\) is used to structurally activate an `Index` on the database at a specific version. See [here](../advanced-usage/indexing.md) for information on creating them.
+An `IndexMigration` \(and `IndexPropertyMigration`\) is used to structurally activate an `Index` on the database at a specific version. See [here](../../advanced-usage/indexing.md) for information on creating them.
 
 `IndexMigration` does not require an `IndexProperty` to run, while `IndexPropertyMigration` makes use of the property to run.
 

usage2/usage/modelviews.md

@@ -25,3 +25,4 @@ The full list of limitations/supported types are: 1. Only `@Column`/`@ColumnMap`
 (select from TestModelView::class
  where ...) // ETC
 ```
+

usage2/usage/observability.md

@@ -134,3 +134,4 @@ Then unregister your model change listener when you don't need it anymore \(to p
 ```java
 DirectModelNotifier.get().unregisterForModelChanges(User.class, modelChangedListener);
 ```
+

usage2/usage/retrieval.md

@@ -4,7 +4,7 @@ DBFlow provides a few ways to retrieve information from the database. Through th
 
 DBFlow provides a few different ways to retrieve information from the database. We can retrieve synchronously or asynchronous \(preferred\).
 
-We can also use `ModelView` \([read here](modelviews.md)\) and `@Index` \([read here](../advanced-usage/indexing.md)\) to perform faster retrieval on a set of data constantly queried.
+We can also use `ModelView` \([read here](modelviews.md)\) and `@Index` \([read here](../../advanced-usage/indexing.md)\) to perform faster retrieval on a set of data constantly queried.
 
 ## Synchronous Retrieval
 
@@ -33,9 +33,9 @@ val anotherObject = (select from Employee::class
  .customSingle<AnotherTable>();
 ```
 
-To query custom objects or lists, see how to do so in [QueryModel](../advanced-usage/querymodels.md).
+To query custom objects or lists, see how to do so in [QueryModel](../../advanced-usage/querymodels.md).
 
-Also you can query a `FlowCursorList`/`FlowTableList` from a query easily via `queryCursorList()` and the `queryTableList()` methods. To see more on these, go to [Flow Lists](../advanced-usage/listbasedqueries.md).
+Also you can query a `FlowCursorList`/`FlowTableList` from a query easily via `queryCursorList()` and the `queryTableList()` methods. To see more on these, go to [Flow Lists](../../advanced-usage/listbasedqueries.md).
 
 ## Asynchronous Retrieval
 

usage2/usage/sqlitewrapperlanguage.md

@@ -102,7 +102,7 @@ This appends a `WHERE (SELECT * FROM {table} )` to the query.
 
 For reference, \([JOIN examples](http:https://www.tutorialspoint.com/sqlite/sqlite_using_joins.htm)\).
 
-`JOIN` statements are great for combining many-to-many relationships. If your query returns non-table fields and cannot map to an existing object, see about [query models](../advanced-usage/querymodels.md)
+`JOIN` statements are great for combining many-to-many relationships. If your query returns non-table fields and cannot map to an existing object, see about [query models](../../advanced-usage/querymodels.md)
 
 For example we have a table named `Customer` and another named `Reservations`.
 

usage2/usage/storingdata.md

@@ -170,3 +170,4 @@ database<AppDatabase>()
  .withPriority(PriorityTransactionWrapper.PRIORITY_HIGH))
  .execute();
 ```
+