Skip to content

Conversation

@mothslaw
Copy link
Contributor

Pull request checklist

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)
  • Build was run locally and any changes were pushed
  • Lint has passed locally and any fixes were made for failures

Pull request type

Please check the type of change your PR introduces:

  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe):

What is the current behavior?

SDK plugins cannot participate in the Empty VDBs feature.

What is the new behavior?

Plugins can now optionally define an initialize operation. This will allow engine users to create empty VDBs against this plugin. (If the plugin does not define the operation, then it does not support empty VDBs, which is totally fine)

Does this introduce a breaking change?

  • Yes
  • No

This kinda looks like a breaking change due to the API changes. However, this feature never worked, and so there is no plugin that could possibly be broken by this change.

Other information

Tested by building one plugin with an initialize operation, and one without. Using a trunk engine, confirmed I could create empty VDBs with one plugin but not the other.

@mothslaw
Copy link
Contributor Author

New image for docs:

VirtualSourceCreateEmpty

Copy link
Contributor

@ravi-cm ravi-cm left a comment

Choose a reason for hiding this comment

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

Looks good.

Copy link
Contributor

@nhlien93 nhlien93 left a comment

Choose a reason for hiding this comment

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

some comments on docs but feel free to drop.

## Empty VDB
A VDB that is created from scratch, without provisioning from another dataset. Users can create empty VDBs when they want to construct a brand-new dataset from within Delphix, instead of creating it externally and then ingesting it.

This "empty" VDB, of course, will typically not stay empty for long. Data will be added as users work with the new dataset.
Copy link
Contributor

Choose a reason for hiding this comment

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

kinda nit, I'm not sure I like this sentence but my suggestions aren't much better. Maybe instead of saying like ths vdb will typically not stay empty for long we can write a more clear sentence about how it starts out empty but can have things written into it depending on the user?

You can leave it this way if too if you disagree with my suggestion.


## Virtual Source Initialize

Initializes a brand-new [empty VDB](Glossary.md#empty-vdb). As with all VDBs, this new dataset will have access to mounted Delphix Engine storage, but of course there will be no data there at first.
Copy link
Contributor

Choose a reason for hiding this comment

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

again not sure if "of course" part really make sense here. I think it's reasonable just to have the sentence say something like:

Initializes a brand-new empty VDB. As with all VDBs, this new dataset will have access to mounted Delphix Engine storage. The VDB will however start out with no data.```

or something along these lines?

@mothslaw mothslaw merged commit f234e12 into delphix:develop Sep 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

4 participants