Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sqlpackage CLI wrpper #1209

Open
wants to merge 10 commits into
base: develop
Choose a base branch
from

Conversation

JinsPeter
Copy link

@JinsPeter JinsPeter commented Jun 30, 2023

I confirm that the pull-request:

  • Follows the contribution guidelines
  • Is based on my own work
  • Is in compliance with my employer

@matkoch
Copy link
Member

matkoch commented Jul 25, 2023

Typo in filename, and markdown file should be removed.

{
"name": "AzureSharedAccessSignatureToken",
"type": "string",
"help": "Azure shared access signature (SAS) token. See [SqlPackage for Azure Synapse Analytics](sqlpackage-for-azure-synapse-analytics.md#publish-import-data)."
Copy link
Member

Choose a reason for hiding this comment

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

Markdown links are not supported. Should be using <a href>

{
"name": "AzureStorageRootPath",
"type": "string",
"help": "Storage root path within the container. Without this property, the path defaults to `servername/databasename/timestamp/`. See [SqlPackage for Azure Synapse Analytics](sqlpackage-for-azure-synapse-analytics.md#publish-import-data)."
Copy link
Member

Choose a reason for hiding this comment

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

Markdown inline code is not supported, should be using <c>. Same goes for a couple of other properties, that can be considered as code (and which aren't even using markdown inline code).

{
"name": "DoNotDropObjectType",
"type": "string",
"help": "An object type that should not be dropped when DropObjectsNotInSource is true. Valid object type names are Aggregates, ApplicationRoles, Assemblies, AssemblyFiles, AsymmetricKeys, BrokerPriorities, Certificates, ColumnEncryptionKeys, ColumnMasterKeys, Contracts, DatabaseOptions, DatabaseRoles, DatabaseTriggers, Defaults, ExtendedProperties, ExternalDataSources, ExternalFileFormats, ExternalTables, Filegroups, Files, FileTables, FullTextCatalogs, FullTextStoplists, MessageTypes, PartitionFunctions, PartitionSchemes, Permissions, Queues, RemoteServiceBindings, RoleMembership, Rules, ScalarValuedFunctions, SearchPropertyLists, SecurityPolicies, Sequences, Services, Signatures, StoredProcedures, SymmetricKeys, Synonyms, Tables, TableValuedFunctions, UserDefinedDataTypes, UserDefinedTableTypes, ClrUserDefinedTypes, Users, Views, XmlSchemaCollections, Audits, Credentials, CryptographicProviders, DatabaseAuditSpecifications, DatabaseEncryptionKeys, DatabaseScopedCredentials, Endpoints, ErrorMessages, EventNotifications, EventSessions, LinkedServerLogins, LinkedServers, Logins, MasterKeys, Routes, ServerAuditSpecifications, ServerRoleMembership, ServerRoles, ServerTriggers, ExternalStreams, ExternalStreamingJobs, DatabaseWorkloadGroups, WorkloadClassifiers, ExternalLibraries, ExternalLanguages. This property may be specified multiple times to indicate multiple options."
Copy link
Member

Choose a reason for hiding this comment

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

This (and others) should use <ul> and <li>.

Copy link
Author

Choose a reason for hiding this comment

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

image

I don't understand why? Looks like this is generating the required documentations
image

Copy link
Member

@matkoch matkoch Jul 25, 2023

Choose a reason for hiding this comment

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

Valid object type names are %enumeration%

Copy link
Author

Choose a reason for hiding this comment

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

Do you mean using

    and
  • can make the valid values into strongly typed nuke string enumerations ?

@matkoch
Copy link
Member

matkoch commented Jul 25, 2023

There are a lot of properties that are unused, ie. don't define a format. What's their purpose?

@JinsPeter
Copy link
Author

There are a lot of properties that are unused, ie. don't define a format. What's their purpose?

Please correct me if wrong, I think you are referring to the delegates array. The purpose of such fields is to be used as KeyValue pair in the format {Key}={Value} Which is defined in the parent json's itemFormat property

@matkoch
Copy link
Member

matkoch commented Jul 25, 2023

Ah, right! I didn't see that. FYI, if different tasks share a lot of common properties, you could use something like this: https://github.com/nuke-build/nuke/blob/develop/source/Nuke.Common/Tools/ReSharper/ReSharper.json#L14

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

Successfully merging this pull request may close these issues.

5 participants