11 |
CREATE
12 |
The CREATE tab is where you instantiate all of your databases and collections. You are currently limited to three (3) databases. Please email us at administrator@sheep.host if you need to rename a database or delete it or any collections within.
13 |
Creating a Database
14 |
Enter the desired name of your database and the name of its first collection.
15 |
Enter your desired schema in the form of a JSON object. Incorrect schema input will be rejected and neither the database or collection will be created.
16 |
Correct example: {String.fromCharCode(123)}"firstName": "String", "lastName": "String", "age": "Number"{String.fromCharCode(125)}
17 |
Inorrect example: firstName: String, lastName: String, age: Number
18 |
Creating a Collection
19 |
To create a new collection within an existing database, simply enter the name of that database in lieu of a new one.
20 |
21 |
22 |
CREATE
23 |
The CREATE tab is where you instantiate all of your databases and collections. You are currently limited to three (3) databases. Please email us at administrator@sheep.host if you need to rename a database or delete it or any collections within.
24 |
Creating a Database
25 |
Enter the desired name of your database and the name of its first collection.
26 |
Enter your desired schema in the form of a JSON object. Incorrect schema input will be rejected and neither the database or collection will be created.
27 |
Correct example: {String.fromCharCode(123)}"firstName": "String", "lastName": "String", "age": "Number"{String.fromCharCode(125)}
28 |
Inorrect example: firstName: String, lastName: String, age: Number
29 |
Creating a Collection
30 |
To create a new collection within an existing database, simply enter the name of that database in lieu of a new one.
31 |
32 |
33 |
DATA
34 |
The Dashboard tab contains all of your data we are hosting. You can navigate between all of your databases and each collection within those databases.
35 |
The particular collection displayed on the dashboard at any given moment will display new documents, updates to existing documents and the removel of documents as those changes come in from your apps.
36 |
API Sandbox
37 |
Below the data is a sandbox for you to prototype your data performing simple CRUD instructions to the collection you are viewing.
38 |
To update or delete documents, enter a JSON object with the {String.fromCharCode(123)}key:value{String.fromCharCode(125)} pair of the document you wish to change into the designated input field.
39 |
To update or add documents, enter the desired information in the form of a JSON object the same way you enter your schema on the CREATE page.
40 |
Example: {String.fromCharCode(123)}"firstName": "John", "lastName": "Doe", "age": "30"{String.fromCharCode(125)}
41 |
42 |
43 |
PROFILE
44 |
The PROFILE tab contains all of your user information, a list of your databases and collections, as well as your API key information.
45 |
Below all of this information is the auto-generated series of script tags to access our SDK...
46 |
47 |
48 |
Using the SDK
49 |
To use the globally exposed sheep object, simply copy the script tags and paste them into the app's HTML file above your Javascript.
50 |
Call the SDK methods via the sheep object, and enter the desired database name and collection as the first two arguments.
51 |
52 |
53 |
GET
54 |
sheep.get( [database_name], [collection_name], callback )
55 |
Returns all of the documents in the collection to the callback in the third argument as an array of objects.
56 |
Example:
57 |
58 |
59 | // Gets all records from the Users collection in the MyApp database and logs them individually{'\n'}{'\n'}
60 | sheep.get(MyApp, Users, (results => {{'\n'}
61 | {' '}results.forEach(record) {{'\n'}
62 | {' '}console.log(record);{'\n'}
63 | {' '}});{'\n'}
64 | });{'\n'}
65 |
66 |
67 |
68 |
69 |
POST
70 |
sheep.post( [database_name], [collection_name], {String.fromCharCode(123)}data{String.fromCharCode(125)})
71 |
Adds a record to a given collection. The third argument, data refers to an object with the key:value pairs, that follows the schema you created for that collection. A successful post will receive a response with status code 200.
72 |
Example:
73 |
74 |
75 | // Adds a record with "John Doe" in the "name field" and "Los Angeles" in the "location" field from the Users collection in the MyApp database{'\n'}{'\n'}
76 | sheep.post(MyApp, Users, { name: "John Doe", location: "New York" }){'\n'}
77 |
78 |
79 |
80 |
81 |
PUT
82 |
sheep.put( [database_name], [collection_name], {String.fromCharCode(123)}query{String.fromCharCode(125)}, {String.fromCharCode(123)}data{String.fromCharCode(125)} )
83 |
Updates a record in a given collection. The third argument, query refers to an object with the key:value pair of the record you want to change, that follows the schema you created for that collection. The fourth argument, data refers to an object with the key:value pair(s) to change. A successful post will receive a response with status code 200.
84 |
Example:
85 |
86 |
87 | // Changes the "location" field of the record with "name" of "John Doe" to "New York" in the Users collection in the MyApp database{'\n'}{'\n'}
88 | sheep.put(MyApp, Users, { name: "John Doe"}, { location: "New York" }){'\n'}
89 |
90 |
91 |
92 |
93 |
DELETE
94 |
sheep.delete( [database_name], [collection_name], {String.fromCharCode(123)}query{String.fromCharCode(125)} )
95 |
Deletes a record in a given collection. The third argument, query refers to an object with the key:value pair of the record you want to delete, that follows the schema you created for that collection. A successful post will receive a response with status code 200.
96 |
Example:
97 |
98 |
99 | // Deletes the record with "John Doe" in the "name" field from the Users collection in the MyApp database{'\n'}{'\n'}
100 | sheep.delete(MyApp, Users, { name: "John Doe" }){'\n'}
101 |
102 |
103 |
104 |
Setting Client Permissions
105 |
You can modify your API Client Key permissions to your data by setting each CRUD method to TRUE or FALSE and clicking save. Changes will not be made until you click the save button. They can be changed at any time. Once a method is set to false, users on your app cannot access that route. This is helpful if you don't want to let users delete or update own records.
106 |
82 | 
94 |