Query all Records: Query records with flexible expressions.
There are 3 parts of the Query all records command: 1. Filter: Filter allows you to pick and choose which records are retrieved when you run this API. You can use the BY JOINS option to perform conditionals on other table properties. There are 3 options for the joins: Inner: An inner join is where you are able to combine two tables based on if they have two of the same properties. For example: if my Tutorial table and my video table both have an owner_id column, I could get the data from both tables where they share the same owner_id value. Left: The left join returns a complete set of rows from the left table with the matching rows if available from the right table. If there is no match, the right side will have null values. Right: The right join or right outer join is a reversed version of the left join. It produces a result set that contains all rows from the right table with matching rows from the left table. If there is no match, the left side will contain null values. There is the option to build a custom query, which allows you to define rules on how you want the records queried. The first step is to configure what the API searches for. You can configure your search based on the different columns of your database table. The left side of the configuration is the column you would like to use. The middle part is the operator where you can select: equals, does not equal, greater than, greater than or equal, less than, less than or equal. The right side is the value that you want to compare the left side to. Here is an example of a configured search:
In this example, we are searching the Tutorial database for all of the records where the views count is greater than or equal to 5. We can make more complex queries using additional conditionals. Clicking on the blue plus button adds more options like "And", "Or", "And()", "Or()". "And": adds to the search where it must match all of the conditions. "Or": adds to the search where it must match either of the conditions. "And()": adds to the search where it must match all of the conditions as well as allowing the user to add an additional set of conditions that are wrapped within the parenthesis. An example of this would be: and( the id < 100 and the id > 30) combined with our other example we would have: Where the number of views is > 5 and (30 < tutorial id < 100). "Or()": adds to the search where it must match either of the conditions as well as allowing the user to add an additional set of conditions that are wrapped within the parenthesis. Additional filtering can be added to the left or right side depending on the Data Type.
2. Output: The output is the Response of the API. Customize allows you to tailor your output to make it exactly what you want it to be. This is helpful to limit the amount of data. Addons can be added to the output to make API calls more powerful by joining an additional database table's information to the Response. These help to make retrieving data easier with one call instead of multiple.
3. Settings: This is where you can add a description for your function.