Initial documentation for Vertica. - #66
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds end-to-end documentation for RepoDB's Vertica support:
RepoDb.Vertica(core provider) andRepoDb.Vertica.BulkOperations(bulk operations extension), following the same structure and conventions already established for the other providers (Db2, Firebird, Oracle, etc.).CultureInfo.InvariantCulturecaveatUseVertica()applies), table/model setup, and every CRUD operation with Vertica-specific behavior and gotchas.VerticaType,SourceColumn,SourceColumnNullMapping,SourceVersion(decoratingVerticaParameter).VerticaBootstrap,VerticaConfiguration,VerticaDbSetting,VerticaDbHelper,VerticaStatementBuilder, three resolvers (VerticaConvertFieldResolver,DbTypeToVerticaStringNameResolver,VerticaDbTypeNameToClientTypeResolver,DbTypeNameToColumnNameResolver), theTimeToDateTimePropertyHandlerproperty handler, and the bulk package'sVerticaBulkInsertMapItem/VerticaTraceKeys. (VerticaBulkCopyisinternaland intentionally has no page.)VerticaBulkImportIdentityBehavior,VerticaBulkImportPseudoTableType.BulkInsert,BulkMerge,BulkUpdate,BulkDelete,BulkDeleteByKey, each with a Mermaid call-flow diagram.release/verticaandrelease/verticabulk, each with a "Known limitations" section._data/documentation.yml's search index, added Vertica to the database picker onhome.md, and to the "Supported Providers" list infeatures/bulkoperations.md.No existing pages for other providers were changed beyond those three registration edits.
Notable findings surfaced as "Known limitations" rather than assumed to work
Documentation was written directly from the
RepoDb.Vertica/RepoDb.Vertica.BulkOperationssource, and a few things worth a second look before this ships as real (non-preview) behavior:Merge/MergeAllmay violate Vertica's own compound-statement restriction.VerticaStatementBuildercompilesMerge/MergeAllas a singleUPDATE ...; INSERT ...command text, with parameters in both halves. Elsewhere in the same codebase,IsInsertAllBatchable's own remarks state thatVerticaCommand"refuses to execute [a compoundstmt1; stmt2statement] once it carries a parameter." These two facts appear to contradict each other. Flagged prominently inrelease/vertica,class/vertica/verticastatementbuilder,operation/vertica, and the Get Started page.GetScopeIdentity/GetScopeIdentityAsyncrunSELECT LAST_INSERT_ID(), and the bulk package's identity read-back arithmetic (subtracting a descending offset from that one value) assumes Vertica assignsIDENTITY/AUTO_INCREMENTvalues strictly contiguously in insertion order. Neither has been checked against a live instance.RepoDb.PropertyHandlers.VerticaTimeToDateTimePropertyHandlerandRepoDb.PropertyHandlers.Vertica.TimeToDateTimePropertyHandlerare near-identical; only the latter is referenced by the library's own integration tests. Documented only the one actually in use, and called out the other as likely dead code from a refactor.Test plan
This is a documentation-only change (Jekyll pages + YAML data, no application code).
bundle exec jekyll build(or equivalent) completes without broken front matter / liquid errors.Mergestatement,LAST_INSERT_ID()assumptions) verified against a live Vertica instance, ideally before or alongside promoting the underlyingRepoDb.Vertica/RepoDb.Vertica.BulkOperationspackages out of preview.