Skip to content
This repository has been archived by the owner on Nov 14, 2024. It is now read-only.

rename TransactionKeyValueService to DataKeyValueService #7307

Merged
merged 5 commits into from
Oct 7, 2024

Conversation

rhuffy
Copy link
Contributor

@rhuffy rhuffy commented Oct 1, 2024

General

Before this PR:
The name "TransactionKeyValueService" was chosen represent the key value interface available within transactions. After some discussion, we determined that this name was confusing, as it is the interface used to operate on data tables, not on the Transactions tables.

After this PR:
DataKeyValueService is a better name, because from the perspective of configuration, the data KVS is responsible for storing the data tables.

This API is currently marked as beta, and there are no production usages at this time, so this rename is safe to do.

==COMMIT_MSG==
rename TransactionKeyValueService to DataKeyValueService
==COMMIT_MSG==

Please tag any other people who should be aware of this PR:
@jeremyk-91

@changelog-app
Copy link

changelog-app bot commented Oct 1, 2024

Generate changelog in changelog/@unreleased

What do the change types mean?
  • feature: A new feature of the service.
  • improvement: An incremental improvement in the functionality or operation of the service.
  • fix: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way.
  • break: Has the potential to break consumers of this service's API, inclusive of both Palantir services
    and external consumers of the service's API (e.g. customer-written software or integrations).
  • deprecation: Advertises the intention to remove service functionality without any change to the
    operation of the service itself.
  • manualTask: Requires the possibility of manual intervention (running a script, eyeballing configuration,
    performing database surgery, ...) at the time of upgrade for it to succeed.
  • migration: A fully automatic upgrade migration task with no engineer input required.

Note: only one type should be chosen.

How are new versions calculated?
  • ❗The break and manual task changelog types will result in a major release!
  • 🐛 The fix changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease.
  • ✨ All others will result in a minor version release.

Type

  • Feature
  • Improvement
  • Fix
  • Break
  • Deprecation
  • Manual task
  • Migration

Description

rename TransactionKeyValueService to DataKeyValueService

Check the box to generate changelog(s)

  • Generate changelog entry

@jeremyk-91
Copy link
Contributor

👋 I'll get some time for this tomorrow!

Copy link
Contributor

@jeremyk-91 jeremyk-91 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thanks for doing this! I verified there are no remaining references to TransactionKeyValueService or \stkvs, other than a couple of variable/parameter names which I've left comments on

@@ -59,8 +59,7 @@ public class GetRowsColumnRangeIteratorTest {
public static final BatchColumnRangeSelection COLUMN_RANGE_SELECTION =
BatchColumnRangeSelection.create(null, null, BATCH_SIZE);

private final TransactionKeyValueService tkvs =
new DelegatingTransactionKeyValueService(new InMemoryKeyValueService(true));
private final DataKeyValueService tkvs = new DelegatingDataKeyValueService(new InMemoryKeyValueService(true));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: let's rename the variable to dkvs?

@@ -73,14 +73,14 @@ public static List<Integer> sizes() {
private RangeRequest rangeRequest;

@Mock
private TransactionKeyValueService tkvs;
private DataKeyValueService tkvs;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah this one should be dkvs too

throws InterruptedException;
}

private Expectations asyncGetExpectation(
TransactionKeyValueService tkvMock, Cell cell, long transactionTs, LockService lockMock) {
DataKeyValueService tkvMock, Cell cell, long transactionTs, LockService lockMock) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: probably dkvMock?

@bulldozer-bot bulldozer-bot bot merged commit 420162f into develop Oct 7, 2024
21 checks passed
@bulldozer-bot bulldozer-bot bot deleted the rh/rename-tkvs branch October 7, 2024 14:17
@autorelease3
Copy link

autorelease3 bot commented Oct 7, 2024

Released 0.1162.0

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants