{"info":{"_postman_id":"291ec8a8-e88b-4f49-80eb-234b1453aeeb","name":"HarperDB","description":"HarperDB postman collection for all features and functionality. \n\nPlease read our <a href=\"https://harperdb.github.io/harperdb/\">getting started guide</a> to help you get up and running.\n\n\n\n\n<b><i>All methods require basic authorization. </i></b> Please read our <a href=\"https://harperdbhelp.zendesk.com/hc/en-us/articles/115010248827-How-do-I-login-authenticate-with-HarperDB-\">guide on Basic Auth</a> to learn more\n\n<i>The port is defined during setup, default port is 9925.</i> \n\nFor support go to http://harperdbhelp.zendesk.com","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json"},"item":[{"name":" Schemas & Tables","item":[{"name":"create_schema","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["postman.setEnvironmentVariable(\"schema\", \"dev\");","console.log(postman.getEnvironmentVariable(\"schema\"));",""]}},{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Create Schema\"] = responseBody.has(\"successfully created\");\r","\r","\r",""]}}],"id":"93af5a8e-3628-4ae8-9b1b-80e863a831ec","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic SERCX0FETUlOOnBhc3N3b3Jk"}],"body":{"mode":"raw","raw":"{\n  \"operation\":\"create_schema\",\n  \"schema\": \"dev\"\n}"},"url":"http://localhost:9925","description":"This method is used to create a schema.   A Schema can be thought of as a container of tables that are independent from tables in other schemas. An example might be the Schema dev could have a table called dog. The Schema Prod could also have a table called dog. \n\n<ul>\n\n<li><b>operation</b><i> (required)</i> - must always be create_schema</li>\n\n<li><b>schema</b><i> (required)</i> - name of the schema you are creating</li>\n\n</ul>"},"response":[{"id":"ea8737f8-5d8d-4a88-88ee-db1b4e62118f","name":"Create dev Schema","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","name":"Authorization","value":"Basic SERCX0FETUlOOjE0MDA="}],"body":{"mode":"raw","raw":"{\n  \"operation\":\"create_schema\",\n  \"schema\": \"dev\"\n}"},"url":"http://localhost:9925"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"45","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":""},{"name":"date","key":"date","value":"Fri, 01 Sep 2017 16:52:45 GMT","description":""},{"name":"etag","key":"etag","value":"W/\"2d-GPJz4Nu7aSF7N/KODFK3o/TNPUw\"","description":""},{"name":"x-powered-by","key":"x-powered-by","value":"HarperDB","description":""}],"cookie":[],"responseTime":null,"body":"{\"message\":\"schema dev successfully created\"}"}],"_postman_id":"93af5a8e-3628-4ae8-9b1b-80e863a831ec"},{"name":"drop_schema","id":"a7b0b7fc-71f0-45d2-8736-b400f517b4aa","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic SERCX0FETUlOOnBhc3N3b3Jk"}],"body":{"mode":"raw","raw":"{\n\"operation\":\"drop_schema\",\n\"schema\":\"dev\"\n\n}"},"url":"http://localhost:9925","description":"This method is used for dropping a schema.  NOTE: Dropping a schema will delete all tables and all of their records in that schema. \n\n<ul>\n<li><b>operation</b><i> (required)</i> - this should always be \"drop_table\"</li>\n\n<li><b>schema</b><i> (required)</i> - name of the schema you are dropping. </li>\n</ul>"},"response":[{"id":"e4171eb7-a189-42fa-8bc5-01d4fdccab7a","name":"Drop dev Schema","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","name":"Authorization","value":"Basic SERCX0FETUlOOjE0MDA="}],"body":{"mode":"raw","raw":"{\n\"operation\":\"drop_schema\",\n\"schema\":\"dev\"\n}"},"url":"http://localhost:9925"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"37","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":""},{"name":"date","key":"date","value":"Fri, 01 Sep 2017 16:54:29 GMT","description":""},{"name":"etag","key":"etag","value":"W/\"25-PimhvvsUauiRfSAGNB/OXJVFwsY\"","description":""},{"name":"x-powered-by","key":"x-powered-by","value":"HarperDB","description":""}],"cookie":[],"responseTime":null,"body":"{\"message\":\"successfully delete dev\"}"}],"_postman_id":"a7b0b7fc-71f0-45d2-8736-b400f517b4aa"},{"name":"describe_schema","id":"2058d743-a187-4487-bd7a-e74fb4ebc257","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic SERCX0FETUlOOnBhc3N3b3Jk"}],"body":{"mode":"raw","raw":"{\n\"operation\":\"describe_schema\",\n\"schema\":\"dev\"\n\n}"},"url":"http://localhost:9925","description":"Method for describing a schema.  This will return each table and its attributes stored under the specified schema.\n\n<ul>\n<li>\n<b>operation</b> <i> (required) </i> - must always be 'describe_schema'\n</li>\n\n\n<li>\n<b>schema </b><i>(required)</i> -schema where the table you wish to describe lives\n</li>\n\n\n</ul>"},"response":[{"id":"4e3fcfb7-05a2-4562-9a0b-78bcc2f0edf8","name":"Describe dev Schema","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","name":"Authorization","value":"Basic SERCX0FETUlOOjE0MDA="}],"body":{"mode":"raw","raw":"{\n\"operation\":\"describe_schema\",\n\"schema\":\"dev\"\n\n}"},"url":"http://localhost:9925"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"546","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":""},{"name":"date","key":"date","value":"Fri, 01 Sep 2017 17:07:43 GMT","description":""},{"name":"etag","key":"etag","value":"W/\"222-SqgWrWhtWV9LK/k7oR3aNPBsFFo\"","description":""},{"name":"x-powered-by","key":"x-powered-by","value":"HarperDB","description":""}],"cookie":[],"responseTime":null,"body":"[{\"schema\":\"dev\",\"name\":\"breed\",\"hash_attribute\":\"id\",\"id\":\"4d560884-0f57-4756-a564-eea76f64d0af\",\"attributes\":[{\"attribute\":\"section\"},{\"attribute\":\"field6\"},{\"attribute\":\"country\"},{\"attribute\":\"name\"},{\"attribute\":\"id\"},{\"attribute\":\"image\"}]},{\"schema\":\"dev\",\"name\":\"dog\",\"id\":\"125ab5c9-f8ac-4197-a348-dd716b0f11ed\",\"hash_attribute\":\"id\",\"attributes\":[{\"attribute\":\"adorable\"},{\"attribute\":\"weight_lbs\"},{\"attribute\":\"owner_name\"},{\"attribute\":\"doc\"},{\"attribute\":\"id\"},{\"attribute\":\"dog_name\"},{\"attribute\":\"age\"},{\"attribute\":\"breed_id\"}]}]"}],"_postman_id":"2058d743-a187-4487-bd7a-e74fb4ebc257"},{"name":"create_table","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Create Table\"] = responseBody.has(\"successfully created.\");"]}}],"id":"c0542557-5435-4eec-8d68-34371e7383a8","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic SERCX0FETUlOOnBhc3N3b3Jk"}],"body":{"mode":"raw","raw":"{\n  \"operation\":\"create_table\",\n  \"schema\":\"dev\",\n  \"table\":\"dog\",\n  \"hash_attribute\": \"id\"\n}"},"url":"http://localhost:9925","description":"This method is used to create a table under the specified schema. \n\n<ul>\n\n<li><b>operation </b><i>(required)</i> - must always be create_table</li>\n\n<li><b>schema</b><i> (required)</i> - name of the schema where you want your table to live </li>\n\n<li><b>table </b><i>(required)</i> - name of the table you are creating</li>\n\n<li><b>hash_attribute</b><i> (required)</i> - hash for the table </li>"},"response":[{"id":"d3e01cc7-5a85-4f71-9d5a-4a55a7f2389e","name":"Create dev.dog Table","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","name":"Authorization","value":"Basic SERCX0FETUlOOjE0MDA="}],"body":{"mode":"raw","raw":"{\n  \"operation\":\"create_table\",\n  \"schema\":\"dev\",\n  \"table\":\"dog\",\n  \"hash_attribute\": \"id\"\n}"},"url":"http://localhost:9925"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"49","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":""},{"name":"date","key":"date","value":"Fri, 01 Sep 2017 17:00:40 GMT","description":""},{"name":"etag","key":"etag","value":"W/\"31-2FV9i2eJXU1F9rNuA4B9T7Vu7EA\"","description":""},{"name":"x-powered-by","key":"x-powered-by","value":"HarperDB","description":""}],"cookie":[],"responseTime":null,"body":"{\"message\":\"table dev.dog successfully created.\"}"}],"_postman_id":"c0542557-5435-4eec-8d68-34371e7383a8"},{"name":"describe_table","id":"c5e2980c-b33b-4994-8984-0bd9850bb48b","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic SERCX0FETUlOOnBhc3N3b3Jk"}],"body":{"mode":"raw","raw":"{\n\"operation\":\"describe_table\",\n\"table\":\"dog\",\n\"schema\":\"dev\"\n\n}"},"url":"http://localhost:9925","description":"Method for describing a table. This will return all attributes under the specified table.\n\n<ul>\n<li>\n<b>operation</b> <i> (required) </i> - must always be 'describe_table'\n</li>\n\n<li>\n<b>table</b> <i>(required)</i> - table you wish to describe\n</li>\n\n<li>\n<b>schema </b><i>(required)</i> -schema where the table you wish to describe lives\n</li>\n\n\n</ul>"},"response":[{"id":"c880dfde-c40a-4a9e-b20d-bbc814bf2da8","name":"Describe dev.dog Table","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","name":"Authorization","value":"Basic SERCX0FETUlOOjE0MDA="}],"body":{"mode":"raw","raw":"{\n\"operation\":\"describe_table\",\n\"table\":\"dog\",\n\"schema\":\"dev\"\n}"},"url":"http://localhost:9925"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"298","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":""},{"name":"date","key":"date","value":"Fri, 01 Sep 2017 17:06:12 GMT","description":""},{"name":"etag","key":"etag","value":"W/\"12a-UwcyoEDwkVEWSNeo7dsNBD12Vcg\"","description":""},{"name":"x-powered-by","key":"x-powered-by","value":"HarperDB","description":""}],"cookie":[],"responseTime":null,"body":"{\"hash_attribute\":\"id\",\"name\":\"dog\",\"id\":\"125ab5c9-f8ac-4197-a348-dd716b0f11ed\",\"schema\":\"dev\",\"attributes\":[{\"attribute\":\"adorable\"},{\"attribute\":\"weight_lbs\"},{\"attribute\":\"owner_name\"},{\"attribute\":\"doc\"},{\"attribute\":\"id\"},{\"attribute\":\"dog_name\"},{\"attribute\":\"age\"},{\"attribute\":\"breed_id\"}]}"}],"_postman_id":"c5e2980c-b33b-4994-8984-0bd9850bb48b"},{"name":"describe_all","id":"8504b153-7949-48d4-b70e-d39a0d526717","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic SERCX0FETUlOOnBhc3N3b3Jk"}],"body":{"mode":"raw","raw":"{\n\"operation\":\"describe_all\"\n\n}"},"url":"http://localhost:9925","description":"Method for describing all schemas and tables.  \n\n<ul>\n<li>\n<b>operation</b> <i> (required) </i> - must always be 'describe_all'\n</li>\n\n\n\n\n</ul>"},"response":[{"id":"d42c94ca-9a57-4970-a372-762e53b31329","name":"Decribe All","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","name":"Authorization","value":"Basic SERCX0FETUlOOjE0MDA="}],"body":{"mode":"raw","raw":"{\n\"operation\":\"describe_all\"\n\n}"},"url":"http://localhost:9925"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"568","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":""},{"name":"date","key":"date","value":"Fri, 01 Sep 2017 17:07:00 GMT","description":""},{"name":"etag","key":"etag","value":"W/\"238-gfg0d+lv1qmocnKKFjlrSBm00dM\"","description":""},{"name":"x-powered-by","key":"x-powered-by","value":"HarperDB","description":""}],"cookie":[],"responseTime":null,"body":"{\"dev\":{\"dog\":{\"hash_attribute\":\"id\",\"id\":\"125ab5c9-f8ac-4197-a348-dd716b0f11ed\",\"name\":\"dog\",\"schema\":\"dev\",\"attributes\":[{\"attribute\":\"adorable\"},{\"attribute\":\"weight_lbs\"},{\"attribute\":\"owner_name\"},{\"attribute\":\"doc\"},{\"attribute\":\"id\"},{\"attribute\":\"dog_name\"},{\"attribute\":\"age\"},{\"attribute\":\"breed_id\"}]},\"breed\":{\"hash_attribute\":\"id\",\"id\":\"4d560884-0f57-4756-a564-eea76f64d0af\",\"name\":\"breed\",\"schema\":\"dev\",\"attributes\":[{\"attribute\":\"section\"},{\"attribute\":\"field6\"},{\"attribute\":\"country\"},{\"attribute\":\"name\"},{\"attribute\":\"image\"},{\"attribute\":\"id\"}]}}}"}],"_postman_id":"8504b153-7949-48d4-b70e-d39a0d526717"},{"name":"drop_table","id":"0a8bb75b-9473-4926-b95b-ca66c00a3d00","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic SERCX0FETUlOOjE0MDA="}],"body":{"mode":"raw","raw":"{\n\"operation\":\"drop_table\",\n\"schema\":\"dev\",\n\"table\":\"dog\"\n}"},"url":"http://localhost:9925","description":"This method is used for dropping a table.  NOTE: Dropping a table will delete all associated records in that table. \n\n<ul>\n<li><b>operation</b><i> (required)</i> - this should always be \"drop_table\"</li>\n\n<li><b>schema</b><i> (required)</i> - schema where the table you are dropping lives. </li>\n\n<li><b>table</b><i> (required)</i> - name of the table you are dropping.  </li>\n\n</ul>"},"response":[{"id":"b3912b54-30b4-489c-b029-1e1c2946c853","name":"Delete dev.dog Table","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","name":"Authorization","value":"Basic SERCX0FETUlOOjE0MDA="}],"body":{"mode":"raw","raw":"{\n\"operation\":\"drop_table\",\n\"schema\":\"dev\",\n\"table\":\"dog\"\n}"},"url":"http://localhost:9925"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"38","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":""},{"name":"date","key":"date","value":"Fri, 01 Sep 2017 17:18:20 GMT","description":""},{"name":"etag","key":"etag","value":"W/\"26-leLMSEjB5MTf4SZHD946SXCcc8U\"","description":""},{"name":"x-powered-by","key":"x-powered-by","value":"HarperDB","description":""}],"cookie":[],"responseTime":null,"body":"{\"message\":\"successfully deleted dog\"}"}],"_postman_id":"0a8bb75b-9473-4926-b95b-ca66c00a3d00"}],"id":"0f951662-1ebe-42de-8bed-bb2698f79d16","_postman_id":"0f951662-1ebe-42de-8bed-bb2698f79d16"},{"name":"Bulk Data Load","item":[{"name":"csv_data_load","id":"4686df82-e333-41b0-88ae-42f223a93896","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic SERCX0FETUlOOjE0MDA="}],"body":{"mode":"raw","raw":"{\n  \"operation\":\"csv_data_load\",\n  \"schema\":\"dev\",\n  \"table\":\"breed\",\n  \"data\":\"id,name,section,country,image\\n1,ENGLISH POINTER,British and Irish Pointers and Setters,GREAT BRITAIN,http://www.fci.be/Nomenclature/Illustrations/001g07.jpg\\n2,ENGLISH SETTER,British and Irish Pointers and Setters,GREAT BRITAIN,http://www.fci.be/Nomenclature/Illustrations/002g07.jpg\\n3,KERRY BLUE TERRIER,Large and medium sized Terriers,IRELAND,\\n\"\n}"},"url":"http://localhost:9925","description":"This method is used to import csv data into HarperDB. The first row should contain column header names which will be used as attribute names.  Each row will be considered a distinct entity in the database.\n\n<ul>\n\n<li><b>operation </b><i>(required)</i> - must always be csv_data_load</li>\n\n<li><b>schema</b><i> (required)</i> - name of the schema where you are loading your data </li>\n\n<li><b>table </b><i>(required)</i> - name of the table where you are loading your data</li>\n\n<li><b>data</b><i> (required)</i> - csv data to import into HaprerDB </li>"},"response":[{"id":"b0980a9f-fdbe-49c0-8905-a4b563a243a4","name":"Load CSV data to dev.breed Table","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic SERCX0FETUlOOjE0MDA="}],"body":{"mode":"raw","raw":"{\n  \"operation\":\"csv_data_load\",\n  \"schema\":\"dev\",\n  \"table\":\"breed\",\n  \"data\":\"id,name,section,country,image\\n1,ENGLISH POINTER,British and Irish Pointers and Setters,GREAT BRITAIN,http://www.fci.be/Nomenclature/Illustrations/001g07.jpg\\n2,ENGLISH SETTER,British and Irish Pointers and Setters,GREAT BRITAIN,http://www.fci.be/Nomenclature/Illustrations/002g07.jpg\\n3,KERRY BLUE TERRIER,Large and medium sized Terriers,IRELAND,\\n\"\n}"},"url":"http://localhost:9925"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"43","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":""},{"name":"date","key":"date","value":"Fri, 01 Sep 2017 17:37:59 GMT","description":""},{"name":"etag","key":"etag","value":"W/\"2b-BuakPyD95UGyo7RugwY93WQjtTU\"","description":""},{"name":"x-powered-by","key":"x-powered-by","value":"HarperDB","description":""}],"cookie":[],"responseTime":null,"body":"{\"message\":\"successfully loaded 3 records\"}"}],"_postman_id":"4686df82-e333-41b0-88ae-42f223a93896"},{"name":"csv_file_load","id":"5a343157-d53f-4de4-8ba6-84aa170af3a4","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic SERCX0FETUlOOjE0MDA="}],"body":{"mode":"raw","raw":"{\n  \"operation\":\"csv_file_load\",\n  \"schema\":\"dev\",\n  \"table\":\"breed\",\n  \"file_path\":\"/home/user/imports/breeds.csv\"\n}"},"url":"http://localhost:9925/","description":"This method is used to import a csv from the file system into HarperDB. The first row should contain column header names which will be used as attribute names.  Each row will be considered a distinct entity in the database.\n\n<ul>\n\n<li><b>operation </b><i>(required)</i> - must always be csv_file_load</li>\n\n<li><b>schema</b><i> (required)</i> - name of the schema where you are loading your data </li>\n\n<li><b>table </b><i>(required)</i> - name of the table where you are loading your data</li>\n\n<li><b>file_path</b><i> (required)</i> - path to the csv file </li>"},"response":[{"id":"8550d3cd-ca21-4f1b-97ac-04c219e21860","name":"Load CSV file to dev.breed Table","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","name":"Authorization","value":"Basic SERCX0FETUlOOjE0MDA="}],"body":{"mode":"raw","raw":"{\n  \"operation\":\"csv_file_load\",\n  \"schema\":\"dev\",\n  \"table\":\"breed\",\n  \"file_path\":\"/home/kyle/Documents/breeds.csv\"\n}"},"url":"http://localhost:9925"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"45","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":""},{"name":"date","key":"date","value":"Fri, 01 Sep 2017 17:41:13 GMT","description":""},{"name":"etag","key":"etag","value":"W/\"2d-59GkoX81i6OMA/OYM8QtTn9XCRY\"","description":""},{"name":"x-powered-by","key":"x-powered-by","value":"HarperDB","description":""}],"cookie":[],"responseTime":null,"body":"{\"message\":\"successfully loaded 350 records\"}"}],"_postman_id":"5a343157-d53f-4de4-8ba6-84aa170af3a4"},{"name":"csv_url_load","id":"c95981fc-635f-4920-b91a-a5a8b74362d2","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic SERCX0FETUlOOjE0MDA="}],"body":{"mode":"raw","raw":"{\n  \"operation\":\"csv_url_load\",\n  \"schema\":\"dev\",\n  \"table\":\"dog\",\n  \"csv_url\":\"https://data.cityofnewyork.us/api/views/kku6-nxdu/rows.csv?accessType=DOWNLOAD\"\n}"},"url":"http://localhost:9925","description":"This method is used to import a csv data from a url into HarperDB. \n\n<ul>\n\n<li><b>operation </b><i>(required)</i> - must always be csv_url_load</li>\n\n<li><b>schema</b><i> (required)</i> - name of the schema where you are loading your data </li>\n\n<li><b>table </b><i>(required)</i> - name of the table where you are loading your data</li>\n\n<li><b>csv_url</b><i> (required)</i> - URL to the csv </li>"},"response":[],"_postman_id":"c95981fc-635f-4920-b91a-a5a8b74362d2"}],"id":"f6c7bc92-596c-4893-aa21-465420249315","_postman_id":"f6c7bc92-596c-4893-aa21-465420249315"},{"name":"Core Operations","item":[{"name":"insert","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Write Single Record\"] = responseBody.has(\"successfully wrote 1 records\");","",""]}}],"id":"30b02569-3017-4663-854d-774561b7f77c","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic SERCX0FETUlOOnBhc3N3b3Jk"}],"body":{"mode":"raw","raw":"{\n\"operation\":\"insert\",\n\"schema\":\"dev\",\n\"table\":\"dog\",\n\"records\": [\n  {\n    \"name\":\"Harper\",\n    \"breed\":\"Mutt\",\n    \"id\":\"1\",\n    \"age\":5\n    \n  },\n  {\n    \"name\":\"Penny\",\n    \"breed\":\"Mutt\",\n    \"id\":\"3\",\n    \"age\":5\n    \n  }\n]\n\n}"},"url":"http://localhost:9925","description":"Method for inserting records. Can be used for a single insert or multiple records.  If a large amount of records are being updated, we recommend using the .CSV load method.  See our article on importing data sets here: https://harperdbhelp.zendesk.com/hc/en-us/articles/115002007573-1Gigabyte-Limit-to-Request-Bodies\n\n<i>NOTE: Hash value of the inserted JSON record MUST be supplied on insert.  </i>\n\n<ul>\n<li><b>operation</b><i> (required)</i> - must always be 'insert'</li>\n\n<li><b>schema</b><i> (required)</i> - schema where the table you are inserting records into lives</li>\n\n<li><b>table</b><i> (required)</i> - table where you want to insert records </li>\n\n<li><b>records</b><i> (required)</i> - array of one or more records for insert</li>\n</ul>"},"response":[{"id":"4d75b6ee-b90c-4861-99ef-a57969a4298f","name":"NoSQL Insert into dev.dog","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","name":"Authorization","value":"Basic SERCX0FETUlOOjE0MDA="}],"body":{"mode":"raw","raw":"{\n\"operation\":\"insert\",\n\"schema\":\"dev\",\n\"table\":\"dog\",\n\"records\": [\n  {\n    \"name\":\"Harper\",\n    \"breed\":\"Mutt\",\n    \"id\":\"1\",\n    \"age\":5\n    \n  },\n  {\n    \"name\":\"Penny\",\n    \"breed\":\"Mutt\",\n    \"id\":\"3\",\n    \"age\":5\n    \n  }\n]\n\n}"},"url":"http://localhost:9925"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"42","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":""},{"name":"date","key":"date","value":"Fri, 01 Sep 2017 17:43:34 GMT","description":""},{"name":"etag","key":"etag","value":"W/\"2a-+I7U4Tpdia9SawmsfcyNUq20tzU\"","description":""},{"name":"x-powered-by","key":"x-powered-by","value":"HarperDB","description":""}],"cookie":[],"responseTime":null,"body":"{\"message\":\"successfully wrote 2 records\"}"}],"_postman_id":"30b02569-3017-4663-854d-774561b7f77c"},{"name":"update","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Write Single Record\"] = responseBody.has(\"successfully wrote 1 records\");","",""]}}],"id":"5420efa0-502e-4ca0-8b66-a834ee92f20d","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic YWRtaW46cGFzc3dvcmQ="}],"body":{"mode":"raw","raw":"{\n\"operation\":\"update\",\n\"schema\":\"dev\",\n\"table\":\"dog\",\n\"records\": [\n  {\n    \"id\": 1,\n    \"weight_lbs\": 55\n  },\n    {\n    \"id\": 3,\n    \"owner\": \"kyle b\",\n    \"weight_lbs\": 35\n  }\n]\n\n}"},"url":"http://localhost:9925","description":"Method for updating records. Can be used for single or multiple records.  \n\n<i>NOTE: Hash value of the updated JSON record MUST be supplied on update.  </i>\n\n<ul>\n<li><b>operation</b><i> (required)</i> - must always be 'update'</li>\n\n<li><b>schema</b><i> (required)</i> - schema of the table you are updating records into </li>\n\n<li><b>table</b><i> (required)</i> - table where you want to update records </li>\n\n<li><b>records</b><i> (required)</i> - array of one or more records for update</li>\n</ul>"},"response":[{"id":"82e8f850-ac71-4db9-b7a3-087bdd71379f","name":"NoSQL Update into dev.dog","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","name":"Authorization","value":"Basic SERCX0FETUlOOjE0MDA="}],"body":{"mode":"raw","raw":"{\n\"operation\":\"update\",\n\"schema\":\"dev\",\n\"table\":\"dog\",\n\"records\": [\n  {\n    \"id\": 1,\n    \"weight_lbs\": 55\n  },\n    {\n    \"id\": 3,\n    \"owner\": \"kyle b\",\n    \"weight_lbs\": 35\n  }\n]\n\n}"},"url":"http://localhost:9925"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"78","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":""},{"name":"date","key":"date","value":"Fri, 01 Sep 2017 17:44:20 GMT","description":""},{"name":"etag","key":"etag","value":"W/\"4e-TQj7cawhxiZSTYGpOL1BQRmQM/8\"","description":""},{"name":"x-powered-by","key":"x-powered-by","value":"HarperDB","description":""}],"cookie":[],"responseTime":null,"body":"{\"message\":\"updated 2 of 2 records\",\"update_hashes\":[1,3],\"skipped_hashes\":[]}"}],"_postman_id":"5420efa0-502e-4ca0-8b66-a834ee92f20d"},{"name":"delete","id":"25dbc821-942e-4b89-9658-ec14ad0b6195","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic SERCX0FETUlOOjE0MDA="}],"body":{"mode":"raw","raw":"{\n\"operation\":\"delete\",\n\"table\":\"dog\",\n\"schema\":\"dev\",\n\"hash_values\":[1,2]\n\n}"},"url":"http://localhost:9925","description":"Method for deleting records. Can be used for a single record or multiple records.    \n\n<ul>\n<li><b>operation</b><i> (required)</i> - must always be 'delete'</li>\n\n<li><b>schema</b><i> (required)</i> - schema where the table you are deleting records into lives</li>\n\n<li><b>table</b><i> (required)</i> - table where you want to deleting records </li>\n\n\n<li><b>records</b><i> (required)</i> - array of one or more records for delete</li>\n</ul>"},"response":[{"id":"5a66e1a7-e83a-4939-84d0-1b5fc9cc5fd3","name":"NoSQL Delete from dev.dog","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","name":"Authorization","value":"Basic SERCX0FETUlOOjE0MDA="}],"body":{"mode":"raw","raw":"{\n\"operation\":\"delete\",\n\"table\":\"dog\",\n\"schema\":\"dev\",\n\"hash_values\":[\"1\",\"3\"]\n}"},"url":"http://localhost:9925"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"42","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":""},{"name":"date","key":"date","value":"Fri, 01 Sep 2017 17:45:32 GMT","description":""},{"name":"etag","key":"etag","value":"W/\"2a-Y+b8ancCZDlk5zkmlNYgvGhMwCE\"","description":""},{"name":"x-powered-by","key":"x-powered-by","value":"HarperDB","description":""}],"cookie":[],"responseTime":null,"body":"{\"message\":\"records successfully deleted\"}"}],"_postman_id":"25dbc821-942e-4b89-9658-ec14ad0b6195"},{"name":"search_by_hash","id":"3fab7f66-0508-4a25-8077-1f402c552690","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic YWRtaW46cGFzc3dvcmQ="}],"body":{"mode":"raw","raw":"{\n  \"operation\":\"search_by_hash\",\n  \"schema\": \"dev\",\n  \"table\": \"dog\",\n  \"hash_attribute\": \"id\",\n  \"hash_values\":[1,2],\n  \"get_attributes\": [\"name\", \"breed\"]\n  \n}"},"url":"http://localhost:9925/","description":"Method for searching records by their hash. Returns an array of records.\n\n<ul>\n<li><b>operation</b><i> (required)</i> - must always be 'search_by_hashes'</li>\n\n<li><b>schema</b> <i>(required)</i> - schema where the table you are searching lives</li>\n\n<li><b>table</b> <i>(required)</i> - table you wish to search</li>\n\n<li><b>hash_attribute</b><i> (required)</i> - hash_attribute for table you are searching. defined in add table</li>\n\n<li><b>hash_values</b><i>(required) </i>- array of hashes to retrive </li>\n\n<li><b>get_attriburtes</b><i> (required)</i> - define which attributes you want returned. <i>Use '*' to return all attributes</i>\n</ul>"},"response":[{"id":"ebe0655a-5c4f-4431-b5d3-619fc625dd7f","name":"NoSQL Search By Hash on dev.dog","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","name":"Authorization","value":"Basic SERCX0FETUlOOjE0MDA="}],"body":{"mode":"raw","raw":"{\n  \"operation\":\"search_by_hash\",\n  \"schema\": \"dev\",\n  \"table\": \"dog\",\n  \"hash_values\":[1,3],\n  \"get_attributes\": [\"*\"]\n}"},"url":"http://localhost:9925"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"145","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":""},{"name":"date","key":"date","value":"Fri, 01 Sep 2017 17:47:21 GMT","description":""},{"name":"etag","key":"etag","value":"W/\"91-7qgDOcZcf+jmd3/hkx3lrpmyUCA\"","description":""},{"name":"x-powered-by","key":"x-powered-by","value":"HarperDB","description":""}],"cookie":[],"responseTime":null,"body":"[{\"age\":5,\"breed\":\"Mutt\",\"id\":1,\"name\":\"Harper\",\"weight_lbs\":55},{\"age\":5,\"breed\":\"Mutt\",\"id\":3,\"name\":\"Penny\",\"owner\":\"kyle b\",\"weight_lbs\":35}]"}],"_postman_id":"3fab7f66-0508-4a25-8077-1f402c552690"},{"name":"search_by_value","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Search by Value: 12345\"] = responseBody.has(12345);"]}}],"id":"67ac550f-becd-4e77-8bb1-0022476ed87f","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic YWRtaW46cGFzc3dvcmQ="}],"body":{"mode":"raw","raw":"{\n\"operation\":\"search_by_value\",\n\"table\":\"dog\",\n\"schema\":\"dev\",\n\"hash_attribute\":\"id\",\n\"search_attribute\":\"breed\",\n\"search_value\":\"Mu*\",\n\"get_attributes\":[\"name\"]\n}"},"url":"http://localhost:9925","description":"Method for searching records by value. Returns an array of records. You can search on any attribute. \n<ul>\n<li>\n    <b> operation </b> <i> (required) </i> - must always be 'search_by_value'\n</li>\n<li>\n    <b> schema </b> <i> (required) </i> - schema where the table you are searching lives\n</li>\n<li>\n    <b> table </b> <i> (required) </i> - table you wish to search\n</li>\n<li>\n    <b> hash_attribute </b> <i> (required) </i> - hash_attribute for table you are searching. defined in add_table\n</li>\n<li>\n    <b> search_attribute </b> <i> (required) </i> - attribute you wish to search can be any attribute \n</li>\n<li>\n    <b> search_value </b> <i> (required) </i> - value you wish to search - wild cards are allowed. \n</li>\n<li>\n    <b> get_attriburtes </b> <i> (required) </i> - define which attributes you want returned. Use '*' to return all attributes.\n</li>\n</ul>"},"response":[{"id":"3555ee6f-f8ad-49d9-9f6e-f20ea99c07ab","name":"Search By Value with wildcard on dev.dog","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","name":"Authorization","value":"Basic SERCX0FETUlOOjE0MDA="}],"body":{"mode":"raw","raw":"{\n\"operation\":\"search_by_value\",\n\"table\":\"breed\",\n\"schema\":\"dev\",\n\"search_attribute\":\"name\",\n\"hash_attribute\" : \"id\",\n\"search_value\":\"ENG*\",\n\"get_attributes\":[\"name\"]\n}"},"url":"http://localhost:9925"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"196","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":""},{"name":"date","key":"date","value":"Fri, 01 Sep 2017 17:49:06 GMT","description":""},{"name":"etag","key":"etag","value":"W/\"c4-O9VcHCK4aciPHIip9yg0ZzRXD2w\"","description":""},{"name":"x-powered-by","key":"x-powered-by","value":"HarperDB","description":""}],"cookie":[],"responseTime":null,"body":"[{\"name\":\"ENGLISH POINTER\"},{\"name\":\"ENGLISH SETTER\"},{\"name\":\"ENGLISH COCKER SPANIEL\"},{\"name\":\"ENGLISH TOY TERRIER (BLACK &TAN)\"},{\"name\":\"ENGLISH SPRINGER SPANIEL\"},{\"name\":\"ENGLISH FOXHOUND\"}]"}],"_postman_id":"67ac550f-becd-4e77-8bb1-0022476ed87f"}],"id":"e8f34893-a530-4a2b-92d3-fb50e9fc853b","_postman_id":"e8f34893-a530-4a2b-92d3-fb50e9fc853b"},{"name":"Roles & Users","item":[{"name":"add_user","id":"d84536ee-7038-41ab-a207-6de7ff00a76e","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic c2dvbGRiZXJnOnRlc3QxMjM0IQ=="}],"body":{"mode":"raw","raw":"{\n\"operation\":\"add_user\",\n\"role\":\"18d678be-97f7-42d9-8074-335e8358646b\",\n\"username\":\"sgoldberg\",\n\"password\":\"test1234!\", \n\"active\":\"true\"\n\n}"},"url":"http://localhost:9925/","description":"Method for adding users.  Users can be assigned roles which provide granular access at a table, operation, and attirbute level.  \n\n<ul>\n<li><b>operation </b> <i>(required) </i> - must always be 'add_user'</li>\n\n<li><b>role </b><i>(required) </i>- id of the role you wish to assign to the user.  See add_role for more detail.  </li>\n\n<li><b>username </b> <i>(required)</i> - username assigned to the user.  It can not be altered after adding the user.  It serves as the hash. </li>\n\n<li><b>password </b> <i>(required) </i>- clear text for password.  HarperDB will encrypt the password upon reciept. </li>\n\n</ul>"},"response":[],"_postman_id":"d84536ee-7038-41ab-a207-6de7ff00a76e"},{"name":"add_role","id":"e1bc96ec-be81-4457-b210-abd1aeadf483","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic YWRtaW46cGFzc3dvcmQ="}],"body":{"mode":"raw","raw":"{\n\"operation\":\"add_role\",\n\"role\":\"develope3r\",\n\"permission\":{\n  \"super_user\": false,\n  \"dev\":{\n\n   \"tables\": {\n     \"dog\": {\n         \"read\":true,\n         \"insert\":true,\n         \"update\":true,\n         \"delete\":false,\n         \"attribute_restrictions\":[\n            {\n               \"attribute_name\": \"name\",\n               \"read\":true,\n               \"insert\":true,\n               \"update\":true,\n               \"delete\":false\n            }\n         ]\n      }\n   }\n}\n\n\n\n\n  }\n\n}"},"url":"http://localhost:9925/","description":"Method for creating roles.  Roles are assigned to users to give them specifc permisisons.  \n\n<ul>\n<li>\n<b>operation</b> <i> (required) </i> - must always be 'add_role'\n</li>\n\n<li>\n<b>role</b> <i>(required)</i> - name of role you are defining \n</li>\n\n<li>\n<b>permission </b><i>(required)</i> - object defining permissions for users associated with this role\n</li>\n\n<li>\n<b>permission.super_admin</b> <i>(optional)</i> - boolean which if set to true gives users associated with this role full access to all operations and methods. \n</li>\n\n<br/>\n\nTo learn more about managing roles <a href=\"https://harperdbhelp.zendesk.com/hc/en-us/articles/115010158848\"> view our help desk article </a>"},"response":[],"_postman_id":"e1bc96ec-be81-4457-b210-abd1aeadf483"},{"name":"alter_user","id":"9b900423-ed78-49ae-90a3-dd560632eee7","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic YWRtaW46cGFzc3dvcmQ="}],"body":{"mode":"raw","raw":"{\n\"operation\":\"alter_user\",\n\"role\":\"2ebc3415-0aa0-4eea-9b8e-40860b436119-1499362372145\",\n\"username\":\"sgoldberg\",\n\"password\":\"password!\"\n\n}"},"url":"http://localhost:9925","description":"Method for altering users.  Users can be assigned roles which provide granular access at a table, operation, and attirbute level.  Use this method to change password as well.  \n\n<ul>\n\n<li><b>operation</b> <i>(required)</i> - must always be 'alter_user'</li>\n\n<li><b>role</b> <i>(optional) </i>- id of the role you wish to assign to the user.  See add_role for more detail. </li> \n\n<li><b>username </b><i>(required)</i> - username assigned to the user.  It can not be altered after adding the user.  It serves as the hash. </li>\n\n<li> <b>password</b><i> (optional) </i>- clear text for password.  HarperDB will encrypt the password upon reciept. </li>\n</ul>"},"response":[],"_postman_id":"9b900423-ed78-49ae-90a3-dd560632eee7"},{"name":"alter_role","id":"2b5bd390-4f78-413b-bd88-7bc3d80a1554","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic YWRtaW46ZmFsc2U="}],"body":{"mode":"raw","raw":"{\n\"operation\":\"alter_role\",\n\"role\":\"developer\",\n\"id\":\"a7cb91e9-32e4-4dbf-a327-fab4fa9191ea\",\n\"permission\":{\n  \"super_user\": false,\n  \"dev\":{\n\n   \"tables\": {\n     \"dog\": {\n         \"read\":true,\n         \"insert\":true,\n         \"update\":true,\n         \"delete\":false,\n         \"attribute_restrictions\":[\n            {\n               \"attribute_name\": \"name\",\n               \"read\":false,\n               \"insert\":true,\n               \"update\":true,\n               \"delete\":false\n            }\n         ]\n      }\n   }\n}\n\n\n\n\n  }\n\n}"},"url":"http://localhost:9925","description":"Method for altering  roles.  Roles are assigned to users to give them specifc permisisons.  \n\n<ul>\n<li><b>operation</b><i> (required)</i> - must always be 'alter_role'</li>\n\n<li><b>role</b><i> (optional)</i> - name of role you are defining </li>\n\n<li><b>permission </b><i>(optional)</i> - object defining permissions for users associated with this role </li>\n\n<li> <b>permission.super_admin (optional) </b> - boolean which if set to true gives users associated with this role full access to all operations and methods. </li>\n\n\n\nTo learn more about managing roles view our help desk article \nhttps://harperdbhelp.zendesk.com/hc/en-us/articles/115010158848"},"response":[],"_postman_id":"2b5bd390-4f78-413b-bd88-7bc3d80a1554"},{"name":"drop_role","id":"f5773091-4ffa-47e6-8be5-519420ca27a3","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic YWRtaW46cGFzc3dvcmQ="}],"body":{"mode":"raw","raw":"{\n\"operation\":\"drop_role\",\n\"id\":\"2ebc3415-0aa0-4eea-9b8e-40860b436119\"\n\n}"},"url":"http://localhost:9925","description":"This method is used for dropping a role.  \n\n<i>You cannot drop a role with associated users.  </i>\n\n<ul>\n<li><b>operation </b><i>(required)</i> - this must always be drop_role </li>\n<li><b>id </b><i>(required) </i> - this is the id of the role you are dropping\n</ul>"},"response":[],"_postman_id":"f5773091-4ffa-47e6-8be5-519420ca27a3"},{"name":"drop_user","id":"6f765db8-b092-4d71-9988-8692e5ee9358","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic YWRtaW46cGFzc3dvcmQ="}],"body":{"mode":"raw","raw":"{\n\"operation\":\"drop_user\",\n\"username\":\"sgoldberg\"\n\n\n}"},"url":"http://localhost:9925/","description":"Method for dropping users.  Users can be assigned roles which provide granular access at a table, operation, and attirbute level. \n\n<ul>\n<li><b>operation </b><i>(required)</i> - must always be 'drop_user'</li>\n\n<li><b>username</b><i> (required)</i> - username assigned to the user. </li>\n</ul>"},"response":[],"_postman_id":"6f765db8-b092-4d71-9988-8692e5ee9358"},{"name":"user_info","id":"c81d2ce2-7b64-4f24-b356-f1351f4058bf","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic YWRtaW46cGFzc3dvcmQ="}],"body":{"mode":"raw","raw":"{\n\"operation\":\"user_info\"\n\n}"},"url":"http://localhost:9925","description":"Method for getting user info.  \n\n<ul>\n<li><b>operation </b> <i>(required) </i> - must always be 'user_info'</li>"},"response":[],"_postman_id":"c81d2ce2-7b64-4f24-b356-f1351f4058bf"},{"name":"list_roles","id":"1487e723-9c16-4242-a62f-e65a945828e5","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic SERCX0FETUlOOnBhc3N3b3Jk"}],"body":{"mode":"raw","raw":"{\n\"operation\":\"list_roles\"\n\n}"},"url":"http://localhost:9925","description":"Method for listing all roles.  \n\n<ul>\n<li><b>operation </b> <i>(required) </i> - must always be 'list_roles'</li>"},"response":[],"_postman_id":"1487e723-9c16-4242-a62f-e65a945828e5"},{"name":"list_users","id":"16b45106-562f-4b69-958a-9a782cde40f6","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic SERCX0FETUlOOnBhc3N3b3Jk"}],"body":{"mode":"raw","raw":"{\n\"operation\":\"list_users\"\n\n}"},"url":"http://localhost:9925","description":"Method for listing all users.  \n\n<ul>\n<li><b>operation </b> <i>(required) </i> - must always be 'list_users'</li>"},"response":[],"_postman_id":"16b45106-562f-4b69-958a-9a782cde40f6"}],"id":"153df363-329e-46e9-9afe-5fa5cfecf7e8","_postman_id":"153df363-329e-46e9-9afe-5fa5cfecf7e8"},{"name":"Utility","item":[{"name":"read_log","id":"3f681982-aae0-4fdd-a298-48c207573832","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic SERCX0FETUlOOnBhc3N3b3Jk"}],"body":{"mode":"raw","raw":"{\n\"operation\":\"read_log\",\n\"limit\":1000,\n\"start\":0,\n\"from\":\"2017-07-10\",\n\"until\":\"2019-07-11\",\n\"order\":\"desc\"\n}"},"url":"http://localhost:9925","description":"Method for querying HarperDB logs. \n\n<ul>\n<li>\n<b>operation</b> <i> (required) </i> - must always be 'read_Log'\n</li>\n\n\n<li>\n<b>limit </b><i>(optional)</i> - number of results returned. Default behavior is 100. Must be a number. \n</li>\n\n\n<li>\n<b>start </b><i>(optional)</i> -result to start with. Must be a number. \n</li>\n\n<li>\n<b>from </b><i>(optional)</i> -date to begin showing log results. Must be \"YYYY-MM-DD\" or \"YYYY-MM-DD hh:mm:ss\"\n</li>\n\n<li>\n<b>until </b><i>(optional)</i> -date to end showing log results. Must be \"YYYY-MM-DD\" or \"YYYY-MM-DD hh:mm:ss\"\n\n</li>\n\n\n<li>\n<b>order </b><i>(optional)</i>  order to display logs desc or asc by timestamp\n\n</li>\n\n\n</ul>"},"response":[],"_postman_id":"3f681982-aae0-4fdd-a298-48c207573832"},{"name":"add_node","id":"efdc6385-0f54-4177-a57d-f754c245cb34","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic SERCX0FETUlOOnBhc3N3b3Jk"}],"body":{"mode":"raw","raw":"{\n\"operation\":\"add_node\",\n\"name\":\"node_1\" ,\n\"port\": \"1114\",\n\"host\":\"localhost\"\n}"},"url":"http://localhost:9925","description":"Method for registering a node for HarperDB Clustering.  Each node must be aware of all other nodes. <b><i> This is a HarperDB Enterprise version only feature </i></b>\n<p>\n<a href=\"https://harperdbhelp.zendesk.com/hc/en-us/articles/115003583194\">See this article for more info</a>\n</p>\n<ul>\n<li>\n<b>operation</b> <i> (required) </i> - must always be 'add_node'\n</li>\n<li>\n<b>name</b> <i> (required) </i> - The name of the node you are registering with this node.  Must match exactly. \n</li>\n<li>\n<b>port</b> <i> (required) </i> - The clustering port for the node you are registering with this node.  Not to be confused with HTTP/S PORTS.\n</li>\n<li>\n<b>host</b> <i> (required) </i> - the uri where the node you are adding to the cluster resides. \n</li>\n\n\n\n\n</ul>"},"response":[],"_postman_id":"efdc6385-0f54-4177-a57d-f754c245cb34"}],"id":"fc07d676-4d05-4d1b-9fa4-f7146ca71a8e","_postman_id":"fc07d676-4d05-4d1b-9fa4-f7146ca71a8e"},{"name":"SQL","item":[{"name":"SQL_insert","event":[{"listen":"test","script":{"type":"text/javascript","exec":["//tests[\"Search by Value: 12345\"] = responseBody.has(12345);"]}}],"id":"e3fe8f35-2f5e-427f-b512-ce1662712b4f","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic YWRtaW46cGFzc3dvcmQ="}],"body":{"mode":"raw","raw":"{\n  \"operation\":\"sql\",\n  \"sql\": \"INSERT INTO dev.dog (id, name) VALUES(22, 'Simon')\"\n}"},"url":"http://localhost:9925","description":"Method for SQL insert. \n<ul>\n<li>\n    <b> operation </b> <i> (required) </i> - must always be 'sql'\n</li>\n<li>\n    <b> sql </b> <i> (required) </i> - use standard SQL\n</li>\n</ul>"},"response":[{"id":"13f64258-b649-4bbc-9f6c-b3453150147e","name":"SQL INSERT into dev.dog","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","name":"Authorization","value":"Basic SERCX0FETUlOOjE0MDA="}],"body":{"mode":"raw","raw":"{\n  \"operation\":\"sql\",\n  \"sql\": \"INSERT INTO dev.dog (id, name) VALUES(2, 'Simon')\"\n}"},"url":"http://localhost:9925"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"42","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":""},{"name":"date","key":"date","value":"Fri, 01 Sep 2017 17:50:08 GMT","description":""},{"name":"etag","key":"etag","value":"W/\"2a-ej8lhx1Q+iRBBct5qevTAGvotAM\"","description":""},{"name":"x-powered-by","key":"x-powered-by","value":"HarperDB","description":""}],"cookie":[],"responseTime":null,"body":"{\"message\":\"successfully wrote 1 records\"}"}],"_postman_id":"e3fe8f35-2f5e-427f-b512-ce1662712b4f"},{"name":"SQL_select","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Search by Value: 12345\"] = responseBody.has(12345);"]}}],"id":"dc14d8d8-405f-4c4c-bb0c-c86a725dab84","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic YWRtaW46cGFzc3dvcmQ="}],"body":{"mode":"raw","raw":"{\n  \"operation\":\"sql\",\n  \"sql\":\"select * from dev.dog where id = 1\"\n}"},"url":"http://localhost:9925","description":"Method for SQL select.\n<ul>\n<li>\n    <b> operation </b> <i> (required) </i> - must always be 'sql' sql(required) - use standard SQL\n</li>\n<li>\n    <b> sql </b> <i> (required) </i> - use standard SQL\n</li>\n</ul>"},"response":[{"id":"2776cc5d-5eaa-4acd-890a-00eb5548ce4f","name":"SQL Simple SELECT","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","name":"Authorization","value":"Basic SERCX0FETUlOOjE0MDA="}],"body":{"mode":"raw","raw":"{\n  \"operation\":\"sql\",\n  \"sql\":\"select * from dev.dog\"\n}"},"url":"http://localhost:9925"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"169","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":""},{"name":"date","key":"date","value":"Fri, 01 Sep 2017 17:51:06 GMT","description":""},{"name":"etag","key":"etag","value":"W/\"a9-3RcAyZsQmL1gDLDXJHp5sTZgr4Y\"","description":""},{"name":"x-powered-by","key":"x-powered-by","value":"HarperDB","description":""}],"cookie":[],"responseTime":null,"body":"[{\"age\":5,\"breed\":\"Mutt\",\"id\":1,\"name\":\"Harper\",\"weight_lbs\":55},{\"id\":2,\"name\":\"Simon\"},{\"age\":5,\"breed\":\"Mutt\",\"id\":3,\"name\":\"Penny\",\"owner\":\"kyle b\",\"weight_lbs\":35}]"},{"id":"a5178b2d-7ea9-4275-b4fb-51fc5f885e6f","name":"SQL SELECT With JOINS AND CONDITIONS","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","name":"Authorization","value":"Basic SERCX0FETUlOOjE0MDA="}],"body":{"mode":"raw","raw":"{\n  \"operation\":\"sql\",\n  \"sql\":\"SELECT d.id, d.dog_name, d.owner_name, b.name, b.section FROM dev.dog AS d INNER JOIN dev.breed AS b ON d.breed_id = b.id WHERE d.owner_name IN ('Kyle', 'Zach', 'Stephen') AND b.section = 'Mutt' ORDER BY d.dog_name\"\n}"},"url":"http://localhost:9925"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"389","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":""},{"name":"date","key":"date","value":"Fri, 01 Sep 2017 17:55:45 GMT","description":""},{"name":"etag","key":"etag","value":"W/\"185-edwDBNLCreSo/YY1IIyzPmR72ec\"","description":""},{"name":"x-powered-by","key":"x-powered-by","value":"HarperDB","description":""}],"cookie":[],"responseTime":null,"body":"[{\"id\":346,\"dog_name\":\"Harper\",\"owner_name\":\"Stephen\",\"name\":\"HUSKY MIX\",\"section\":\"Mutt\"},{\"id\":347,\"dog_name\":\"Billy\",\"owner_name\":\"Zach\",\"name\":\"LABRADOR / GREAT DANE MIX\",\"section\":\"Mutt\"},{\"id\":348,\"dog_name\":\"Rose Merry\",\"owner_name\":\"Zach\",\"name\":\"TERRIER MIX\",\"section\":\"Mutt\"},{\"id\":350,\"dog_name\":\"Gemma\",\"owner_name\":\"Stephen\",\"name\":\"SHORT HAIRED SETTER MIX\",\"section\":\"Mutt\"}]"}],"_postman_id":"dc14d8d8-405f-4c4c-bb0c-c86a725dab84"},{"name":"SQL_update","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Search by Value: 12345\"] = responseBody.has(12345);"]}}],"id":"f90da525-8732-4436-ae25-6e41f13a006b","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic YWRtaW46cGFzc3dvcmQ="}],"body":{"mode":"raw","raw":"{\n  \"operation\":\"sql\",\n  \"sql\":\"update dev.dog set name = 'penelope' where id = 1\"\n}"},"url":"http://localhost:9925","description":"Method for SQL update.\n\n<ul>\n<li>\n    <b> operation </b> <i> (required) </i> - must always be 'sql' \n</li>\n\n<li>\n    <b> sql </b> <i> (required) </i> - use standard SQL\n</li>\n</ul>"},"response":[],"_postman_id":"f90da525-8732-4436-ae25-6e41f13a006b"},{"name":"SQL_delete","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Search by Value: 12345\"] = responseBody.has(12345);"]}}],"id":"1ba3ad6b-16c7-4f4e-bc60-78cfa8f692e1","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic SERCX0FETUlOOjE0MDA="}],"body":{"mode":"raw","raw":"{\n  \"operation\":\"sql\",\n  \"sql\":\"DELETE FROM dev.dog WHERE id = 1\"\n}"},"url":"http://localhost:9925","description":"Method for SQL delete. \n<ul>\n<li>\n    <b> operation </b>  <i> (required) </i> - must always be 'sql' \n</li>\n\n<li>\n    <b> sql </b> <i> (required) </i> - use standard SQL\n</li>\n</ul>"},"response":[{"id":"0c45e8bf-93ed-4757-9af8-75011f53c97e","name":"SQL DELETE","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","name":"Authorization","value":"Basic SERCX0FETUlOOjE0MDA="}],"body":{"mode":"raw","raw":"{\n  \"operation\":\"sql\",\n  \"sql\":\"DELETE FROM dev.dog WHERE id = 1\"\n}"},"url":"http://localhost:9925"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"42","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":""},{"name":"date","key":"date","value":"Fri, 01 Sep 2017 17:57:30 GMT","description":""},{"name":"etag","key":"etag","value":"W/\"2a-Y+b8ancCZDlk5zkmlNYgvGhMwCE\"","description":""},{"name":"x-powered-by","key":"x-powered-by","value":"HarperDB","description":""}],"cookie":[],"responseTime":null,"body":"{\"message\":\"records successfully deleted\"}"}],"_postman_id":"1ba3ad6b-16c7-4f4e-bc60-78cfa8f692e1"}],"id":"3b4c24f9-f7f0-4f26-a1f4-49fd3363bde5","_postman_id":"3b4c24f9-f7f0-4f26-a1f4-49fd3363bde5"}]}