Kotlin Extension

Flutter Version

Deprecation Notice

Getting Started with Nitrite

How To Install

<dependencyManagement>    <dependencies>        <dependency>            <groupId>org.dizitart</groupId>            <artifactId>nitrite-bom</artifactId>            <version>[latest version]</version>            <scope>import</scope>            <type>pom</type>        </dependency>    </dependencies></dependencyManagement><dependencies>    <dependency>        <groupId>org.dizitart</groupId>        <artifactId>nitrite</artifactId>    </dependency>    <dependency>        <groupId>org.dizitart</groupId>        <artifactId>nitrite-mvstore-adapter</artifactId>    </dependency></dependencies>

implementation(platform("org.dizitart:nitrite-bom:[latest version]"))    implementation'org.dizitart:nitrite'implementation'org.dizitart:nitrite-mvstore-adapter'

Examples

Quick Examples

// create a mvstore backed storage moduleMVStoreModulestoreModule =MVStoreModule.withConfig()    .filePath("/tmp/test.db")     .compress(true)    .build();// or a rocksdb based storage moduleRocksDBModulestoreModule =RocksDBModule.withConfig()    .filePath("/tmp/test.db")    .build();// initialization using builderNitritedb =Nitrite.builder()        .loadModule(storeModule)        .loadModule(newJacksonMapperModule())// optional        .openOrCreate("user","password");

// Create a Nitrite CollectionNitriteCollectioncollection =db.getCollection("test");// Create an Object RepositoryObjectRepository<Employee>repository =db.getRepository(Employee.class);

@Entity(value ="retired-employee",// entity name (optional),indices = {@Index(value ="firstName",type =IndexType.NON_UNIQUE),@Index(value ="lastName",type =IndexType.NON_UNIQUE),@Index(value ="note",type =IndexType.FULL_TEXT),})publicclassEmployeeimplementsSerializable {// provides id field to uniquely identify an object inside an ObjectRepository@IdprivatelongempId;privateDatejoinDate;privateStringfirstName;privateStringlastName;privateStringnote;// ... public getters and setters}

// create a document to populate dataDocumentdoc =Document.createDocument("firstName","John")     .put("lastName","Doe")     .put("birthDay",newDate())     .put("data",newbyte[] {1,2,3})     .put("fruits",newArrayList<String>() {{add("apple");add("orange");add("banana"); }})     .put("note","a quick brown fox jump over the lazy dog");// insert the documentcollection.insert(doc);// find a documentcollection.find(where("firstName").eq("John").and(where("lastName").eq("Doe"));// update the documentcollection.update(where("firstName").eq("John"),createDocument("lastName","Wick"));// remove the documentcollection.remove(doc);// insert an object in repositoryEmployeeemp =newEmployee();emp.setEmpId(124589);emp.setFirstName("John");emp.setLastName("Doe");repository.insert(emp);

// create document indexcollection.createIndex(indexOptions(IndexType.NON_UNIQUE),"firstName","lastName");// compound indexcollection.createIndex(indexOptions(IndexType.FULL_TEXT),"note");// full-text index// create object index. It can also be provided via annotationrepository.createIndex(indexOptions(IndexType.NON_UNIQUE),"firstName");

DocumentCursorcursor =collection.find(where("firstName").eq("John")// firstName == John    .and(where("data").elemMatch("$".lt(4))// AND elements of data array is less than 4            .and(where("note").text("quick")// AND note field contains string 'quick' using full-text index        )           ));for (Documentdocument :cursor) {// process the document}// get document by idDocumentdocument =collection.getById(nitriteId);// query an object repository and create the first resultCursor<Employee>cursor =repository.find(where("firstName").eq("John"));Employeeemployee =cursor.firstOrNull();

try (Sessionsession =db.createSession()) {try (Transactiontransaction =session.beginTransaction()) {NitriteCollectiontxCol =transaction.getCollection("test");Documentdocument =createDocument("firstName","John");txCol.insert(document);transaction.commit();    }catch (TransactionExceptione) {transaction.rollback();    }}

Migrationmigration1 =newMigration(Constants.INITIAL_SCHEMA_VERSION,2) {@Overridepublicvoidmigrate(InstructionSetinstructions) {instructions.forDatabase()// make a non-secure db to secure db            .addUser("test-user","test-password");// create instructions for existing repositoryinstructions.forRepository(OldClass.class,"demo1")// rename the repository (in case of entity name changes)            .renameRepository("migrated",null)// change datatype of field empId from String to Long and convert the values            .changeDataType("empId", (TypeConverter<String,Long>)Long::parseLong)// change id field from uuid to empId            .changeIdField(Fields.withNames("uuid"),Fields.withNames("empId"))// delete uuid field            .deleteField("uuid")// rename field from lastName to familyName            .renameField("lastName","familyName")// add new field fullName and add default value as - firstName + " " + lastName            .addField("fullName",document ->document.get("firstName",String.class) +" "                +document.get("familyName",String.class))// drop index on firstName            .dropIndex("firstName")// drop index on embedded field literature.text            .dropIndex("literature.text")// change data type of embedded field from float to integer and convert the values            .changeDataType("literature.ratings", (TypeConverter<Float,Integer>)Math::round);    }};Migrationmigration2 =newMigration(2,3) {@Overridepublicvoidmigrate(InstructionSetinstructions) {instructions.forCollection("test")            .addField("fullName","Dummy Name");    }};MVStoreModulestoreModule =MVStoreModule.withConfig()    .filePath("/temp/employee.db")    .compressHigh(true)    .build();db =Nitrite.builder()    .loadModule(storeModule)// schema versioning is must for migration    .schemaVersion(2)// add defined migration paths    .addMigrations(migration1,migration2)    .openOrCreate();

// Export data to json file// create export optionsExportOptionsexportOptions =newExportOptions();// set the nitrite factoryexportOptions.setNitriteFactory(() ->openDb("test.db"));// set the collections to exportexportOptions.setCollections(List.of("first"));// set the repositories to exportexportOptions.setRepositories(List.of("org.dizitart.no2.support.data.Employee","org.dizitart.no2.support.data.Company"));// set the keyed repositories to exportexportOptions.setKeyedRepositories(Map.of("key",Set.of("org.dizitart.no2.support.data.Employee")));// create an exporter with export optionsExporterexporter =Exporter.withOptions(exportOptions);exporter.exportTo("test.json");// Import data from the file// create import optionsImportOptionsimportOptions =newImportOptions();// set the nitrite factoryimportOptions.setNitriteFactory(() ->openDb("new-test.db"));// create an importer with import optionsImporterimporter =Importer.withOptions(importOptions);importer.importFrom("test.json");

Release Notes

Documentation

Build

git clone https://github.com/nitrite/nitrite-java.gitcd nitrite-javamvn clean install

Support / Feedback

Bugs / Feature Requests

Maintainers

Contributors

Sponsors

Presentation & Talks

Special Thanks