{"id":28401915,"url":"https://github.com/griddb/webapi","last_synced_at":"2026-03-10T09:07:01.388Z","repository":{"id":93750842,"uuid":"177558083","full_name":"griddb/webapi","owner":"griddb","description":"GridDB WebAPI","archived":false,"fork":false,"pushed_at":"2025-06-05T09:07:23.000Z","size":748,"stargazers_count":5,"open_issues_count":3,"forks_count":5,"subscribers_count":7,"default_branch":"master","last_synced_at":"2026-03-02T20:43:07.038Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/griddb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-03-25T09:49:32.000Z","updated_at":"2025-06-05T08:53:12.000Z","dependencies_parsed_at":null,"dependency_job_id":"a8471f40-4458-4bed-aaac-1a994f2adbbb","html_url":"https://github.com/griddb/webapi","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/griddb/webapi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/griddb%2Fwebapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/griddb%2Fwebapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/griddb%2Fwebapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/griddb%2Fwebapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/griddb","download_url":"https://codeload.github.com/griddb/webapi/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/griddb%2Fwebapi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30328281,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-10T05:25:20.737Z","status":"ssl_error","status_checked_at":"2026-03-10T05:25:17.430Z","response_time":106,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-01T14:06:40.579Z","updated_at":"2026-03-10T09:07:01.206Z","avatar_url":"https://github.com/griddb.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"GridDB WebAPI\n\n## Overview\n\nGridDB WebAPI is developed using GridDB Java Client and [Spring Boot](https://spring.io/projects/spring-boot).  \n\n## Operating environment\n\nBuilding of the library and execution of the sample programs have been checked in the following environment.\n- OS: Ubuntu 22.04(x64)\n- [GridDB Server](https://github.com/griddb/griddb): 5.9\n\n## QuickStart\n\n### Build and Run \n        \n1. Execute the command on project directory.\n\n        $ cd webapi-ce\n        $ ./gradlew build\n\n    The following jar file is created.\n    - webapi-ce/build/libs/griddb-webapi-ce-X.X.X.jar\n\n2. Set the GS_WEBAPI_HOME variable for GridDB WebAPI home directory .\n\n        $ export GS_WEBAPI_HOME=$PWD/..\n\n    Default is /var/lib/gridstore/webapi.\n\n3. Edit parameter files\n\n        Edit the following files on the ${GS_WEBAPI_HOME}/conf directory\n        - repository.json\n        - griddb_webapi.properties (if necessary)\n\n        When you change port (default is 8081) used in URI, please do the following steps.\n        1. Copy webapi-ce/src/main/resource/application.properties to your working directory\n        2. Edit server.port in it\n\n4. Run with Jar\n\n        java -jar ./build/libs/griddb-webapi-ce-X.X.X.jar\n\n### Execution Example\n\nGridDB Server need to be started in advance.\n\n1. Create a container\n\n        #Request  http://[host]:[port]/griddb/v2/[clusterName]/dbs/public/containers \n        $ curl -X POST --basic -u admin:admin -H \"Content-type:application/json\" -d \n        '{\"container_name\":\"test\", \"container_type\":\"COLLECTION\", \"rowkey\":true, \n        \"columns\":[{\"name\":\"col1\", \"type\":\"STRING\", \"index\":[\"TREE\"]}, \n          {\"name\":\"col2\", \"type\":\"INTEGER\"}, {\"name\":\"col3\", \"type\":\"BOOL\"}]}' \n        http://127.0.0.1:8081/griddb/v2/mycluster/dbs/public/containers\n\n2. Append a row data\n\n        #Request  http://[host]:[port]/griddb/v2/[clusterName]/dbs/public/containers/[containerName]/rows \n        $ curl -X PUT --basic -u admin:admin -H \"Content-type:application/json\" -d \n        '[[\"value\", 1, true]]' \n        http://127.0.0.1:8081/griddb/v2/mycluster/dbs/public/containers/test/rows \n\n3. Get a row data\n\n        #Request  http://[host]:[port]/griddb/v2/[clusterName]/dbs/public/containers/[containerName]/rows \n        $ curl -X POST --basic -u admin:admin -H \"Content-type:application/json\" -d \n        '{\"limit\":1000}'\n        http://127.0.0.1:8081/griddb/v2/mycluster/dbs/public/containers/test/rows \n        --\u003e {\"columns\":[{\"name\":\"col1\",\"type\":\"STRING\"},{\"name\":\"col2\",\"type\":\"INTEGER\"}, \n              {\"name\":\"col3\",\"type\":\"BOOL\"}],\"rows\":[[\"value\",1,true]],\"offset\":0,\"limit\":1000,\"total\":1}\n\n4. Query with TQL\n\n        #Request  http://[host]:[port]/griddb/v2/[clusterName]/dbs/public/tql \n        $ curl -X POST --basic -u admin:admin -H \"Content-type:application/json\" -d \n        '[{\"name\":\"test\", \"stmt\":\"select *\", \"columns\":[]}]' \n        http://127.0.0.1:8081/griddb/v2/mycluster/dbs/public/tql \n        --\u003e [{\"columns\":[{\"name\":\"col1\",\"type\":\"STRING\"},{\"name\":\"col2\",\"type\":\"INTEGER\"}, \n               {\"name\":\"col3\",\"type\":\"BOOL\"}],\"results\":[[\"value\",1,true]],\"offset\":0,\"limit\":1000000,\"total\":1}]\n\n5. Query with SQL\n\n        #Request  http://[host]:[port]/griddb/v2/[clusterName]/dbs/public/sql/select \n        $ curl -X POST -u admin:admin -H \"Content-type:application/json; charset=UTF-8\" \n        -d '[{\"stmt\":\"select * from test\"}]' \n        http://127.0.0.1:8081/griddb/v2/mycluster/dbs/public/sql/dml/query \n        --\u003e [{\"columns\":[{\"name\":\"col1\",\"type\":\"STRING\"},{\"name\":\"col2\",\"type\":\"INTEGER\"}, \n               {\"name\":\"col3\",\"type\":\"BOOL\"}],\"results\":[[\"value\",1,true]]}]\n\n        Note: \"/:cluster/dbs/:database/sql/select\" style is not recommended.\n\n6. Update with SQL\n\n        #Request  http://[host]:[port]/griddb/v2/[clusterName]/dbs/public/sql/update \n        $ curl -X POST -u admin:admin -H \"Content-type:application/json; charset=UTF-8\" \n        -d '[{\"stmt\":\"update test set col3 = false where col2 = 1\"}]' \n        http://127.0.0.1:8081/griddb/v2/mycluster/dbs/public/sql/dml/update \n        --\u003e [{\"status\":1, \"updatedRows\":1,\n               \"stmt\":\"update test set col3 = false where col2 = 1\", \"message\":null}]\n\n        Note: \"/:cluster/dbs/:database/sql/update\" style is not recommended.\n\nPlease refer to the file below for more detailed information.  \n  - [WebAPI Reference (en)](GridDB_Web_API_Reference.md)\n  - [WebAPI Reference (ja)](GridDB_Web_API_Reference_ja.md)\n\n## Community\n\n  * Issues  \n    Use the GitHub issue function if you have any requests, questions, or bug reports. \n  * PullRequest  \n    Use the GitHub pull request function if you want to contribute code.\n    You'll need to agree GridDB Contributor License Agreement(CLA_rev1.1.pdf).\n    By using the GitHub pull request function, you shall be deemed to have agreed to GridDB Contributor License Agreement.\n\n## License\n  \n  GridDB WebAPI source license is Apache License, version 2.0.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgriddb%2Fwebapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgriddb%2Fwebapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgriddb%2Fwebapi/lists"}