Azure / Azure/data-api-builder

[Enh]: Hide deprecated flags from dab add and update

オープン
#3,315 コメント 0 件 リアクション 0 件 担当者 1 名 @Aniruddh25 が担当を希望しています GitHub で見る
2.1 cli usability
主要言語
C#
スター
1.5k
フォーク
370
平均マージ
3日 22時間
マージ済み PR(30日)
9

説明

## What?

✅ Hide `dab add --source.params` in the CLI `--help` to encourage the new syntax.
✅ Hide `dab update --source.params` in the CLI `--help` to encourage the new syntax.
✅ Hide `dab update --source.key-fields` in the CLI `--help` to encourage the new syntax.
✅ Hide `dab update -m` in the CLI `--help` to encourage the new syntax.
✅ Hide `dab update --map` in the CLI `--help` to encourage the new syntax.

### Include deprecation warning

```
dab add --source.params is deprecated, next time use --parameters.*
dab update --source.params is deprecated, next time use --parameters.*
dab update --source.key-fields is deprecated, next time use --fields.*
dab update -m is deprecated, next time use --fields.*
dab update --map is deprecated, next time use --fields.*
```

## Why?

Encourage the new syntax.

### Parameters

In `dab add` and `update`, this:

```
--source.params Dictionary of parameters and their values...
```

Have been replaced with:

```
--parameters.name Comma-separated list of parameter names for stored procedure.

--parameters.description Comma-separated list of parameter descriptions for stored procedure.

--parameters.required Comma-separated list of parameter required flags (true/false) for stored procedure.

--parameters.default Comma-separated list of parameter default values for stored procedure.
```

### Fields

In `dab update`, these:

```
--source.key-fields The field(s) to be used as primary keys.

-m, --map Specify mappings between database fields...
```

Have been replaced with:

```
--fields.name Name of the database column to expose as a field.

--fields.alias Alias for the field.

--fields.description Description for the field.

--fields.primary-key Set this field as a primary key.
```

コントリビューションガイド

コントリビューションガイドを開く

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。