This java based springboot demo project will be of great help, to first time users of Kiara DB, in order for them, to get started straight away with hands-on experience in building search queries for several use cases, using a sample built-in imdb movie database. Once you get comfortable and realise the value that Kiara DB provides, by giving freedom to search by anything, at high performance, without any composite indexes, you may then dig in for more advanced concepts and details.
This step by step readme doc will guide you, as to how this demo project should be used. Additionally if you prefer watching a tutorial video, rather than reading the doc, you may watch the tutorial video at this link:-
https://www.youtube.com/watch?v=b-IqstIuUDY&t=593s
https://www.youtube.com/watch?v=-AL6TrOgdKI
https://www.youtube.com/watch?v=-T-Bwu0WQAI
Following third party packages must be installed on your system
- Java runtime 1.8 and above
- Maven
- Git
Kiara uses Lombok, if you are using an IDE that does not have a lombok plugin installed, the IDE might report you errors, but the code will just build fine. https://projectlombok.org
$ git clone https://github.com/kapoorlabs/kiara-demo.git$ cd kiara-demo/
$ mvn clean installFrom the root folder of the project
$ java -jar target/kiara-demo-0.0.1-SNAPSHOT.jar- When the project is started, you would see a message "Started KiaraDemoApplication" on your command screen.
- Demo project uses port 8080, so if some app on your machine is already using that port, you will have to terminate that app, to free up the port.
The movie database you will be querying is loaded from a csv file, which can be found at: - https://github.com/kapoorlabs/kiara-demo/blob/master/src/main/resources/movie_metadata.csv if you make any changes to the csv file in your local repo, repeate Steps 2 and 3, which will load the new updated dataset.
For the simplicity of this demo we have chosen to demonstrate the queries through a REST API interface, but keep in mind that KIARA DB is a Java library, which can be used in any Java project and not just a REST API.
You can use a tool like postman to Submit queries as a POST request.
The URL of your application will be: -
https://localhost:8080/movie.htmlThe URL for Airport type ahead demo would be
https://localhost:8080/airport.htmlThe URL for Movie keyword demo would be
https://localhost:8080/keyword.htmlThe request has only 2 following Json fields: -
- filterSet - this is an optional field, which is an array of string values, representing the data attributes you would want in your result.
- conditions - This is an array of conditions or the search criteria, using which you can build KIARA DB's queries. A condition has following 3 parts/fields : -
- fieldName - The data attribute on which the condition is applied.
- Operator - Kiara SDK has some rich set of operators, which forms the search critera. You can get complete list and details about operators at: https://www.kapoorlabs.com/kiara-deep-dive/#contentSimpleOperations
- Values - the list of String values, the operator will operate on.
Below are some examples that will solidify your understanding:-
Search criteria:
- Movies of either Tom Hanks or Nick Searcy
- Which is a COLOR film.
- Whose aspect ratio is 1.85
- Released in USA
- With duration greater than 120 minutes.
- Number of faces in poster were either 1 or 2
- Budget was greater than 50 Million
- Which was not directed by Penny Marshall
- With content rating not equal to R
- Belonging to either Drama or Action genres
- With IMDB score greater than 7
- With number of critic reviews greater than 200
- Released between 2000-2005
- Plot involves christmas and survival
And.... the answer is Cast Away
{
"filterSet": ["movie_title"],
"conditions": [
{
"fieldName" : "ACTORS",
"operator" : "CONTAINS_EITHER",
"values" : [
"Tom Hanks",
"Nick Searcy"
]
},
{
"fieldName" : "COLOR",
"operator" : "EQUAL",
"values" : ["Color"]
},
{
"fieldName" : "ASPECT_RATIO",
"operator" : "EQUAL",
"values" : ["1.85"]
},
{
"fieldName" : "COUNTRY",
"operator" : "EQUAL",
"values" : ["USA"]
},
{
"fieldName" : "DURATION",
"operator" : "GREATER_THAN",
"values" : ["120"]
},
{
"fieldName" : "FACE_NUMBER_IN_POSTER",
"operator" : "EQUAL",
"values" : [
"2",
"1"
]
},
{
"fieldName" : "BUDGET",
"operator" : "GREATER_THAN",
"values" : ["50000000"]
},
{
"fieldName" : "DIRECTOR_NAME",
"operator" : "NOT_EQUAL",
"values" : ["Penny Marshall"]
},
{
"fieldName" : "CONTENT_RATING",
"operator" : "NOT_EQUAL",
"values" : ["R"]
},
{
"fieldName" : "GENRES",
"operator" : "CONTAINS_EITHER",
"values" : [
"Drama",
"Action"
]
},
{
"fieldName" : "IMDB_SCORE",
"operator" : "GREATER_THAN_EQUAL",
"values" : ["7"]
},
{
"fieldName" : "NUM_CRITIC_FOR_REVIEWS",
"operator" : "GREATER_THAN",
"values" : ["200"]
},
{
"fieldName" : "TITLE_YEAR",
"operator" : "BETWEEN",
"lowerValue" : "2000",
"upperValue" : "2005"
},
{
"fieldName" : "PLOT_KEYWORDS",
"operator" : "CONTAINS_ALL",
"values" : [
"christmas",
"survival"
]
}
]
}.
Search criteria: Movies that have BOTH Kate Winslet and Leonardo DiCaprio, with selected attributes.
{
"filterSet": ["movie_title", "duration", "plot_keywords","actors"],
"conditions": [
{
"fieldName" : "actors",
"operator" : "CONTAINS_ALL",
"values" : ["Kate Winslet", "Leonardo DiCaprio"]
}
]
}
.
Search criteria: Movies that have BOTH Kate Winslet and Leonardo DiCaprio, with ALL attributes.
{
"conditions": [
{
"fieldName" : "actors",
"operator" : "CONTAINS_ALL",
"values" : ["Kate Winslet", "Leonardo DiCaprio"]
}
]
}
.
Search criteria: Movies that contains EITHER had Kate Winslet OR Leonardo DiCaprio, with selected attributes.
{
"filterSet": ["movie_title", "duration", "plot_keywords","actors"],
"conditions": [
{
"fieldName" : "actors",
"operator" : "CONTAINS_EITHER",
"values" : ["Kate Winslet", "Leonardo DiCaprio"]
}
]
}
.
Search criteria: Movies of Leonardo DiCaprio that he didn't do with Kate Winslet, with selected attributes.
{
"filterSet": ["movie_title", "duration", "plot_keywords","actors"],
"conditions": [
{
"fieldName" : "actors",
"operator" : "CONTAINS_EITHER",
"values" : ["Leonardo DiCaprio"]
},
{
"fieldName" : "actors",
"operator" : "NOT_CONTAINS",
"values" : ["Kate Winslet"]
}
]
}
.
Search criteria: Movies of Leonardo DiCaprio that he didn't do with either Kate Winslet or Christoph Waltz.
{
"filterSet": ["movie_title", "duration", "plot_keywords","actors"],
"conditions": [
{
"fieldName" : "actors",
"operator" : "CONTAINS_EITHER",
"values" : ["Leonardo DiCaprio"]
},
{
"fieldName" : "actors",
"operator" : "NOT_CONTAINS",
"values" : ["Kate Winslet", "Christoph Waltz"]
}
]
}
.
Search criteria: Movies of Dwayne Johnson that came after 2011.
{
"filterSet": ["movie_title", "plot_keywords","actors", "title_year"],
"conditions": [
{
"fieldName" : "actors",
"operator" : "EQUAL",
"values" : ["Dwayne Johnson"]
},
{
"fieldName" : "title_year",
"operator" : "GREATER_THAN",
"values" : ["2011"]
}
]
}
.
Search criteria: Comedy Movies of Dwayne Johnson that came after 2011
{
"filterSet": ["movie_title", "plot_keywords","actors", "title_year","genres"],
"conditions": [
{
"fieldName" : "actors",
"operator" : "EQUAL",
"values" : ["Dwayne Johnson"]
},
{
"fieldName" : "title_year",
"operator" : "GREATER_THAN",
"values" : ["2011"]
} ,
{
"fieldName" : "genres",
"operator" : "CONTAINS_EITHER",
"values" : ["Comedy"]
}
]
}
.
Search criteria: Either Comedy or Fantasy Movies of Dwayne Johnson that came after 2011
{
"filterSet": ["movie_title", "plot_keywords","actors", "title_year","genres"],
"conditions": [
{
"fieldName" : "actors",
"operator" : "EQUAL",
"values" : ["Dwayne Johnson"]
},
{
"fieldName" : "title_year",
"operator" : "GREATER_THAN",
"values" : ["2011"]
} ,
{
"fieldName" : "genres",
"operator" : "CONTAINS_EITHER",
"values" : ["Comedy", "Fantasy"]
}
]
}
.
Search criteria: Comedy PLUS Fantasy Movies of Dwayne Johnson that came after 2011
{
"filterSet": ["movie_title", "plot_keywords","actors", "title_year","genres"],
"conditions": [
{
"fieldName" : "actors",
"operator" : "EQUAL",
"values" : ["Dwayne Johnson"]
},
{
"fieldName" : "title_year",
"operator" : "GREATER_THAN",
"values" : ["2011"]
} ,
{
"fieldName" : "genres",
"operator" : "CONTAINS_ALL",
"values" : ["Comedy", "Fantasy"]
}
]
}
.
Visit www.kapoorlabs.com/kiara to get latest info