featurebase/dax
Travis Turner 3ee936ebc8 Introduce TableKeyer interface; use in Execute() calls as "index" (#2350)
This commit introduces an interface called `TableKeyer` which anything that means to represent a "table"
can implement. Examples are `dax.QualifiedTable`, `dax.Table`, and `string` (for legacy pilosa calls
where Execute simply took `index string`).

In the case of `orchestrator.Execute()` and `qualifiedOrchestrator.Execute()`, we are intentionally strict
about which type of `TableKeyer` the respective method accepts. If we find, in the future, this is too
restrictive, we can loosen that; but for now it helps us understand what is expected.

(cherry picked from commit a61d1a9571)
2023-01-10 23:19:19 +00:00
..
boltdb Sync from private repo to commit 12d608c80d 2022-12-12 09:01:20 -08:00
computer Sync from private repo to commit 12d608c80d 2022-12-12 09:01:20 -08:00
http Sync from private repo to commit 12d608c80d 2022-12-12 09:01:20 -08:00
inmem Sync from private repo to commit 12d608c80d 2022-12-12 09:01:20 -08:00
mds Sync from private repo to commit 12d608c80d 2022-12-12 09:01:20 -08:00
queryer Introduce TableKeyer interface; use in Execute() calls as "index" (#2350) 2023-01-10 23:19:19 +00:00
server Sync from private repo to commit 12d608c80d 2022-12-12 09:01:20 -08:00
snapshotter Sync from private repo to commit 12d608c80d 2022-12-12 09:01:20 -08:00
test Introduce TableKeyer interface; use in Execute() calls as "index" (#2350) 2023-01-10 23:19:19 +00:00
writelogger Sync from private repo to commit 12d608c80d 2022-12-12 09:01:20 -08:00
address.go Introduce ServiceManager and Refactor DAX Integration tests (#2320) 2022-12-12 09:01:20 -08:00
address_test.go Sync from private repo to commit 12d608c80d 2022-12-12 09:01:20 -08:00
dax.go Add DAX - full list of squashed commits below 2022-12-12 09:01:20 -08:00
directive.go rename shard partition field (#2302) 2022-12-12 09:01:20 -08:00
docker-compose.yml Add DAX - full list of squashed commits below 2022-12-12 09:01:20 -08:00
errors.go Sync from private repo to commit 12d608c80d 2022-12-12 09:01:20 -08:00
Makefile Prepend header bytes to WriteLog messages for backward compatibility (#2309) 2022-12-12 09:01:20 -08:00
node.go Sync from private repo to commit 12d608c80d 2022-12-12 09:01:20 -08:00
README.md Add DAX - full list of squashed commits below 2022-12-12 09:01:20 -08:00
role.go rename shard partition field (#2302) 2022-12-12 09:01:20 -08:00
service_manager.go Sync from private repo to commit 12d608c80d 2022-12-12 09:01:20 -08:00
snapshot.go Add DAX - full list of squashed commits below 2022-12-12 09:01:20 -08:00
table.go Introduce TableKeyer interface; use in Execute() calls as "index" (#2350) 2023-01-10 23:19:19 +00:00
table_test.go Sync from private repo to commit 12d608c80d 2022-12-12 09:01:20 -08:00
time.go Add DAX - full list of squashed commits below 2022-12-12 09:01:20 -08:00
versioned_field.go rename shard partition field (#2302) 2022-12-12 09:01:20 -08:00
versioned_partition.go Introduce ServiceManager and Refactor DAX Integration tests (#2320) 2022-12-12 09:01:20 -08:00
versioned_shard.go rename shard partition field (#2302) 2022-12-12 09:01:20 -08:00
versionstore.go rename shard partition field (#2302) 2022-12-12 09:01:20 -08:00
workerjob.go Add DAX - full list of squashed commits below 2022-12-12 09:01:20 -08:00
workerjob_test.go Add DAX - full list of squashed commits below 2022-12-12 09:01:20 -08:00

DAX

DAX encapsulates anything which covers all of the services which make up the "disaggregation of storage and compute" project. Initially, this will include integration tests which pull in things like Metadata Services (MDS), including the Controller, as well as FeatureBase and IDK-based ingesters.

Setting up the tests

The DAX test currently requires docker images for: featurebase and datagen.

If at any point you run into problems with go mod failing to reference a private repo, make sure that you have gitlab.com/molecula in your GOPRIVATE environment variable.

Note that during the docker image build step, go mod vendor is run, which creates a vendor directory in the root directory, and copies that to docker during the build stage. Just be aware of this; you may want to remove that vendor directory after you're done building docker images.

Possible Configuruation

The following were relevent when the dax code was in a separate repository. These may no longer be relevant.

I needed to but this in my ~/.profile file:

export GOPRIVATE=github.com/molecula,gitlab.com/molecula

And this in my ~/.gitconfig

[url "ssh://git@github.com/"]
	insteadOf = https://github.com/
[url "ssh://git@gitlab.com/"]
	insteadOf = https://gitlab.com/

Then make docker ran successfully.

Build the FeatureBase docker image

  • Check out the dax branch of the featurebase repository.
  • Run make docker-image-featurebase to build the docker image
  • You should now have an image in docker named dax/featurebase with the tag latest.

Build the Datagen docker image

  • cd <featurebase_repo_root>/idk
  • Run make docker-image-datagen to build the docker image
  • You should now have an image in docker named dax/datagen with the tag latest.

Running the tests

  • Check out the dax branch of the featurebase repository.
  • Change into the dax directory: cd dax
  • Run make test-integration.