{"id":16389766,"url":"https://github.com/FeatureBaseDB/pdk","last_synced_at":"2025-10-26T13:30:43.629Z","repository":{"id":57494657,"uuid":"81382053","full_name":"FeatureBaseDB/pdk","owner":"FeatureBaseDB","description":"Pilosa Dev Kit - implementation tooling and use case examples are here!","archived":true,"fork":false,"pushed_at":"2022-09-27T21:01:34.000Z","size":5807,"stargazers_count":31,"open_issues_count":20,"forks_count":21,"subscribers_count":25,"default_branch":"master","last_synced_at":"2024-06-20T00:54:29.947Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FeatureBaseDB.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-02-08T22:20:37.000Z","updated_at":"2023-01-27T20:46:55.000Z","dependencies_parsed_at":"2022-08-28T16:10:40.703Z","dependency_job_id":null,"html_url":"https://github.com/FeatureBaseDB/pdk","commit_stats":null,"previous_names":["pilosa/pdk"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FeatureBaseDB%2Fpdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FeatureBaseDB%2Fpdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FeatureBaseDB%2Fpdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FeatureBaseDB%2Fpdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FeatureBaseDB","download_url":"https://codeload.github.com/FeatureBaseDB/pdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219862888,"owners_count":16555951,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":"2024-10-11T04:34:13.663Z","updated_at":"2025-10-26T13:30:42.351Z","avatar_url":"https://github.com/FeatureBaseDB.png","language":"Go","funding_links":[],"categories":["Software"],"sub_categories":["Tools"],"readme":"# pdk\n\nThis repo archived Sept 2022 as part of the transition from Pilosa to FeatureBase.\nPlease contact community[at]featurebase[dot]com with any questions.\n\n[![CircleCI](https://circleci.com/gh/pilosa/pdk.svg?style=shield)](https://circleci.com/gh/pilosa/pdk)\n[![Go Report Card](https://goreportcard.com/badge/github.com/pilosa/pdk)](https://goreportcard.com/report/github.com/pilosa/pdk)\n[![GoDoc](https://godoc.org/github.com/pilosa/pdk?status.svg)](https://godoc.org/github.com/pilosa/pdk)\n\nPilosa Dev Kit - implementation tooling and use case examples are here!\n\nDocumentation is here: https://www.pilosa.com/docs/pdk/\n\n## Requirements\n\n* A running instance of Pilosa. See: https://www.pilosa.com/docs/getting-started/\n\n* A recent version of [Go](https://golang.org/doc/install).\n\n## Installing\n\nWe assume you are on a UNIX-like operating system. Otherwise adapt the following instructions for your platform. We further assume that you have a [Go development environment](https://golang.org/doc/install) set up. You should have $GOPATH/bin on your $PATH for access to installed binaries.\n\n* `go get github.com/pilosa/pdk`\n* `cd $GOPATH/src/github.com/pilosa/pdk`\n* `make install`\n\n## Running Tests\n\nTo run unit tests\n`make test`\n\nTo run unit and integration tests, first, install and start the Confluent stack:\n1. Download tarball here: https://www.confluent.io/download \n2. Decompress, enter directory, then,\n3. Run `./bin/confluent start kafka-rest`\nNow that's running, you can do\n`make test TESTFLAGS=\"-tags=integration\"`\n\n## Taxi usecase\n\nTo get started immediately, run this:\n\n`pdk taxi`\n\nThis will create and fill an index called `taxi`, using the short url list in usecase/taxi/urls-short.txt.\n\nIf you want to try out the full data set, run this:\n\n`pdk taxi -i taxi-big -f usecase/taxi/greenAndYellowUrls.txt`\n\nThere are a number of other options you can tweak to affect the speed and memory usage of the import (or point it to a remote pilosa instance). Use `pdk taxi --help` to see all the options.\n\nNote that this url file represents 1+ billion columns of data - depending on your hardware this will probably take well over 3 hours, and consume quite a bit of memory (and CPU). You can make a file with fewer URLs if you just want to get a sample.\n\nAfter importing, you can try a few example queries at https://github.com/alanbernstein/pilosa-notebooks/blob/master/taxi-use-case.ipynb .\n\n## Net usecase\n\nTo get started immediately, run this:\n\n`pdk net -i en0`\n\nwhich will capture traffic on the interface `en0` (see available interfaces with `ifconfig`).\n\n## SSB\n\nThe Star Schema Benchmark is a benchmark based on [TPC-H](www.tpc.org/tpch/) but tweaked for a somewhat difference use case. It has been implemented by some big data projects such as https://hortonworks.com/blog/sub-second-analytics-hive-druid/ .\n\nTo execute the star schema benchmark with Pilosa, you must.\n\n1. Generate the SSB data at a particular scale factor.\n2. Import the data into Pilosa.\n3. Run the `demo-ssb` application for convenience which has all of the SSB queries pre-written.\n\n### Generating SSB data\nUse https://github.com/electrum/ssb-dbgen.git to generate the raw SSB data. This can be a bit finicky to work with - hit up @tgruben for tips (or maybe he'll update this section :wink:.\n\nWhen generating the data, you have to select a particular scale factor - the size of the generated data will be about 600MB * SF(scale factor), so SF=100 will generate about 60GB of data.\n\n### Import data into Pilosa.\nUse `pdk ssb` to import the data into Pilosa. You must specify the directory containing the `.tbl` files generated in the first step as well as the location of your pilosa cluster. There are a few other options which you can tweak which may help import performance. See `pdk ssb -h` for more information.\n\n### Run demo-ssb\nThis repo https://github.com/pilosa/demo-ssb.git contains a small Go program which packages up the different queries which comprise the benchmark. Running demo-ssb starts a web server which executes queries against pilosa on your behalf. You can simply run (e.g.) `curl localhost:8000/query/1.1` to run an SSB query.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFeatureBaseDB%2Fpdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FFeatureBaseDB%2Fpdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFeatureBaseDB%2Fpdk/lists"}