Skip to content
This repository has been archived by the owner on Feb 11, 2022. It is now read-only.

Commit

Permalink
Renames the project and uses the new readme structure
Browse files Browse the repository at this point in the history
  • Loading branch information
@xrigau
xrigau committed Nov 14, 2014
1 parent 169e5d0 commit faee861
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 197 deletions.
219 changes: 25 additions & 194 deletions README.md
View file
@@ -1,215 +1,46 @@
SQLiteProvider [![](http://ci.novoda.com/buildStatus/icon?job=SQLiteProvider)](http://ci.novoda.com/job/SQLiteProvider/lastSuccessfulBuild/console)
================================================
# sqlite-provider [![](http://ci.novoda.com/buildStatus/icon?job=sqlite-provider)](http://ci.novoda.com/job/sqlite-provider/lastSuccessfulBuild/console) [![](https://raw.githubusercontent.com/novoda/novoda/master/assets/btn_apache_lisence.png)](LICENSE.txt)

A simplification of database access.
A simplification of database access for Android.

SQLiteProvider implements a ContentProvider for you that allows database access using [Uri][1]'s

Download
--------
## Description

Add it to your projects via Gradle or Maven:
sqlite-provider implements a ContentProvider for you that allows database access using [Uri][1]'s
The library is meant to augment the ContentProvider interface to fit SQLite in a more pronounced way. The aim is to set convention on queries via URI.

Gradle:
````groovy
dependencies {
compile 'com.novoda:sqliteprovider-core:1.0.3'
}
````
Maven:
````xml
<dependency>
<groupId>com.novoda</groupId>
<artifactId>sqliteprovider-core</artifactId>
<version>1.0.3</version>
</dependency>
````

You just need to declare jCenter in the list of repositories:

Gradle:
````groovy
repositories {
jcenter()
}
````
Maven:
````xml
<repositories>
<repository>
<id>bintray-jcenter</id>
<url>http://jcenter.bintray.com</url>
</repository>
</repositories>
````

Check the [WIKI][5] for further instruction

[ ![Download](https://api.bintray.com/packages/novoda/maven/sqliteprovider-core/images/download.svg) ](https://bintray.com/novoda/maven/sqliteprovider-core/_latestVersion)

Usage
--------

Simple example source code can be found in this demo module: [Android Simple Demo][3]

Advanced queries & source code can be found in this demo module: [Android Extended Demo][4]


Overview
--------

The library is meant to augment the ContentProvider interface to fit SQLite in a more pronounced way. The aim is
to set convention on queries via URI.

The following Uris are possible (some may not be supported yet):

### General Uri by convention

Generic table support:

Uri: content://<authority>/tableName
Sql: select * from "tableName"

Primary key support:

Uri: content://<authority>/tableName/1
Sql: select * from "tableName" where _id=1

One to many support:

Uri: content://<authority>/tableName/1/child
Sql: select * from "child" where tableName_id=1

Group by & having support:

Uri: content://<authority>/tableName?groupBy=col&having=value
Sql: select * from tableName group by col having value

limit support:

Uri: content://<authority>/tableName?limit=number
Sql: select * from tableName limit number

distinct support:

Uri: content://<authority>/tableName?distinct=true
Sql: select distinct * from tableName limit number

join support (TODO):

Uri: content://<authority>/parent/1/child/2
Sql: select * from child inner join parent on parent._id=child.parent_id;


### Info Uri

Gives the ability to query information from the table SQLITE_MASTER and versionning.

content://<authority>/_info

Querying the above will yield the following cursor:

type TEXT | name TEXT | tbl_name TEXT | rootpage INTEGER | sql TEXT

If you are interested to only get the table name, the following should be helpful:

getContentResolver().query(Uri.parse("content://<authority>/_info"), new String[] {"name"}, null, null, null);


To get the current version of the database similar to "select sqlite_version() AS sqlite_version":
## Adding to your project

content://<authority>/_info?version

returns the following cursor:
To start using this library, add these lines to the `build.gradle` of your project:

sqlite_version TEXT

### Size management

Executing some file resizing using vacuum

content://<authority>/_vacuum

(TODO) set max size??

### Pragma Uris


Ability to execute Pragma calls against SQLite. This is handy to get further info on table or set values such as "PRAGMA synchronous=OFF"

content://<authority>/_pragma?<pragma_name>=<value>

For instance the following will exectute "PRAGMA synchronous=OFF"

content://<authority>/_pragma?synchronous=OFF

The following will give back table information for a specific table:

content://<authority>/_pragma?table_info("tableName")

The resulting cursor is

column name | data type | can be NULL? | the default value for the column


### Table creation

If you insert against

content://<authority>/_db?create=<tableName>&withId=<true|false>&foreignKey=[<comma_separated_list_of_parent_tables>]&createdAt=false&updatedAt=false

(TODO) alter?

```
tableName (mandatory): the table name
withId (optional): automatically add "_id PRIMARY KEY AUTOINCREMENT" - default is true
foreignKey (optional): automatically add <fk_name>_id as foreign key to table creation
createdAt (optional): will put a createdAt field which contains creation date - default to insert
updatedAt (optional): will put a updatedAt field which contains update date - default to insert
```

you should have content values put with "column name" mapped to a SQLite type (look at SQLiteType)
```groovy
repositories {
jcenter()
}
```java
Uri uri = Uri.parse("content://authority/_db?create=table");
ContentValues values = new ContentValues();
values.put("name", "TEXT");
values.put("rid", "INTEGER");
getContentResolver().insert(uri, values);
dependencies {
compile 'com.novoda:sqlite-provider:1.0.3'
}
```

Build
-----

To build the core library jar you can use the following gradle command;

./gradlew assembleRelease

This will result in the core jar being available at

core/build/bundles/release/classes.jar
## Simple usage

Simple example source code can be found in this demo module: [Android Simple Demo][2]

License
-------
Advanced queries & source code can be found in this demo module: [Android Extended Demo][3]

(c) Copyright 2014 Novoda

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
## Links

http://www.apache.org/licenses/LICENSE-2.0
Here are a list of useful links:

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.
* We always welcome people to contribute new features or bug fixes, [here is how](https://github.com/novoda/novoda/blob/master/CONTRIBUTING.md)
* If you have a problem check the [Issues Page](https://github.com/novoda/sqlite-provider/issues) first to see if we are working on it
* For further usage or to delve more deeply checkout the [Project Wiki](https://github.com/novoda/sqlite-provider/wiki)
* Looking for community help, browse the already asked [Stack Overflow Questions](http://stackoverflow.com/questions/tagged/support-sqlite-provider) or use the tag: `support-sqlite-provider` when posting a new question


[1]: http://developer.android.com/reference/android/net/Uri.html
[2]: https://github.com/novoda/public-mvn-repo/raw/master/releases/com/novoda/sqliteprovider-core/1.0.1/sqliteprovider-core-1.0.1.jar
[3]: https://github.com/novoda/SQLiteProvider/tree/master/demo-simple
[4]: https://github.com/novoda/SQLiteProvider/tree/master/demo-extended
[5]: https://github.com/novoda/SQLiteProvider/wiki
[2]: https://github.com/novoda/SQLiteProvider/tree/master/demo-simple
[3]: https://github.com/novoda/SQLiteProvider/tree/master/demo-extended
6 changes: 3 additions & 3 deletions core/build.gradle
View file
Expand Up @@ -24,8 +24,8 @@ android {
publish {
userOrg = 'novoda'
groupId = 'com.novoda'
artifactId = 'sqliteprovider-core'
version = '1.0.5-SNAPSHOT'
artifactId = 'sqlite-provider'
version = '1.0.5'
description = 'Extended SQLite functionality for Android'
website = 'https://github.com/novoda/SQLiteProvider'
website = 'https://github.com/novoda/sqlite-provider'
}

0 comments on commit faee861

Please sign in to comment.