diff --git a/README.md b/README.md index 451158ca..ebb0ab10 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@

ThoughtSpot | CS Tools
- Scale your ThoughtSpot adoption with tools created by the ThoughtSpot Solutions organization. + 🧙 Give your Admins magic powers with tools created by the ThoughtSpot Customer Success Team.

Learn more in our documentation @@ -13,9 +13,9 @@

## Features -- Explore your ThoughtSpot platform data with the [__Searchable Liveboards__]() -- Clean stale and forgotten Answers and Liveboards with [__Archiver__]() -- Extract your ThoughtSpot data to popular formats with Syncers +- Explore your ThoughtSpot platform data with the [__Searchable Liveboards__](https://thoughtspot.github.io/cs_tools/generated/cli/reference.html#searchable) +- Clean stale and forgotten Answers and Liveboards with [__Archiver__](https://thoughtspot.github.io/cs_tools/generated/cli/reference.html#archiver) +- Extract your ThoughtSpot data to popular formats with [__Syncers__](https://thoughtspot.github.io/cs_tools/syncer/what-is/) - Multi-platform support (connect to your __Dev__, __QA__, and __Prod__!) - Supports the latest ThoughtSpot version on Software & Cloud - Install anywhere: Windows, MacOS, Linux, and serverless @@ -24,9 +24,9 @@ --- > [!IMPORTANT] -> While **CS Tools** is maintained by members of the __ThoughtSpot__ team, it is totally free! +> While **CS Tools** is maintained by members of the __ThoughtSpot__ team, they are __TOTALLY FREE__! > -> _The tools are provided on as-is basis._ +> ❗ __ThoughtSpot [Support Team](https://community.thoughtspot.com/__ will be unable to help you resolve any issues. > > :bulb: __Feature Requests__ and :ring_buoy: __Support__ are handled [__here on Github Discussions__](https://github.com/thoughtspot/cs_tools/discussions). > @@ -35,7 +35,7 @@ ## Installation -Please see the [__Getting Started guide in our documentation__](https://thoughtspot.github.io/cs_tools/tutorial/intro/). +Please see the [__Getting Started guide in our documentation__](https://thoughtspot.github.io/cs_tools/getting-started/). ## Development Installation @@ -59,5 +59,7 @@ Please see [__CONTRIBUTING.md__](./CONTRIBUTING.md) for details on how to contri [![Test CS Tools Bootstrapper](https://github.com/thoughtspot/cs_tools/actions/workflows/test-bootstrapper.yaml/badge.svg)](https://github.com/thoughtspot/cs_tools/actions/workflows/test-bootstrapper.yaml) 🧰 -[![Extract Metadata with CS Tools.](https://github.com/thoughtspot/cs_tools/actions/workflows/fetch-metdata.yaml/badge.svg)](https://github.com/thoughtspot/cs_tools/actions/workflows/fetch-metdata.yaml) -[![Extract BI Server with CS Tools.](https://github.com/thoughtspot/cs_tools/actions/workflows/fetch-bi-data.yaml/badge.svg)](https://github.com/thoughtspot/cs_tools/actions/workflows/fetch-bi-data.yaml) +[![Extract Metadata](https://github.com/thoughtspot/cs_tools/actions/workflows/fetch-metdata.yaml/badge.svg)](https://github.com/thoughtspot/cs_tools/actions/workflows/fetch-metdata.yaml) +[![Extract BI Server](https://github.com/thoughtspot/cs_tools/actions/workflows/fetch-bi-data.yaml/badge.svg)](https://github.com/thoughtspot/cs_tools/actions/workflows/fetch-bi-data.yaml) +[![Extract Audit Logs](https://github.com/thoughtspot/cs_tools/actions/workflows/fetch-audit-logs.yaml/badge.svg)](https://github.com/thoughtspot/cs_tools/actions/workflows/fetch-audit-logs.yaml) +[![Extract TML](https://github.com/thoughtspot/cs_tools/actions/workflows/fetch-tml.yaml/badge.svg)](https://github.com/thoughtspot/cs_tools/actions/workflows/fetch-tml.yaml) diff --git a/docs/changelog/1.6.0.md b/docs/changelog/1.6.0.md index ef34e6cd..1a7e0cbe 100644 --- a/docs/changelog/1.6.0.md +++ b/docs/changelog/1.6.0.md @@ -97,6 +97,13 @@ hide: curl -LsSf https://thoughtspot.github.io/cs_tools/install.py | python - --reinstall --beta v1.5.12 ``` + === "`cs_tools tools searchable metadata`" + The `TS_SHARING_ACCESS` table previously did not identify __column level security__{ .fc-purple }, even if you + used the `--include-column-access` option on the CLI. Whoops! :disappointed_relieved: + + __In order to accept the new data type, you can choose to issue a `DROP TABLE TS_SHARING_ACCESS` and allow __CS + Tools__ to recreate it, or you can issue an `ALTER TABLE ADD COLUMN share_type VARCHAR` command.__{ .fc-red } + === "`cs_tools tools scriptability`" This tool allows you to handle TML in bulk (exports and imports), while also encouraging strong CI/CD workflows. Over the years, the __ThoughtSpot__ team has worked to refine the capabilities in the platform to help alleviate @@ -237,7 +244,7 @@ hide: # INSTALL A SPECIFIC VERSION OF cs_tools. - name: Install a pinned version of CS Tools - run: python -m pip install "cs_tools[cli] @ https://github.com/thoughtspot/cs_tools/archive/v${{ env.CS_TOOLS_VERSION }}.zip" + run: python -m pip install "cs_tools[cli] @ https://github.com/thoughtspot/cs_tools/archive/${{ env.CS_TOOLS_VERSION }}.zip" # ENSURE SYNCER DEPENDENCIES ARE INSTALLED. # found in: https://github.com/thoughtspot/cs_tools/blob/master/sync//MANIFEST.json @@ -296,7 +303,7 @@ hide: - python -m pip install --upgrade pip # INSTALL A SPECIFIC VERSION OF cs_tools. - - python -m pip install "cs_tools[cli] @ https://github.com/thoughtspot/cs_tools/archive/v${CS_TOOLS_VERSION}.zip" + - python -m pip install "cs_tools[cli] @ https://github.com/thoughtspot/cs_tools/archive/${CS_TOOLS_VERSION}.zip" # ENSURE SYNCER DEPENDENCIES ARE INSTALLED. # found in: https://github.com/thoughtspot/cs_tools/blob/master/sync//MANIFEST.json @@ -327,7 +334,7 @@ hide: # CS TOOLS IS COMMAND LINE LIBRARY WRAPPING TS APIS # https://thoughtspot.github.io/cs_tools/ - CS_TOOLS_VERSION: '1.6.0' + CS_TOOLS_VERSION: 'v1.6.0' CS_TOOLS_THOUGHTSPOT__URL: $(THOUGHTSPOT_URL) CS_TOOLS_THOUGHTSPOT__USERNAME: $(THOUGHTSPOT_USERNAME) CS_TOOLS_THOUGHTSPOT__SECRET_KEY: $(THOUGHTSPOT_SECRET_KEY) @@ -379,7 +386,7 @@ hide: python -m pip install --upgrade pip # INSTALL A SPECIFIC VERSION OF cs_tools - python -m pip install "cs_tools[cli] @ https://github.com/thoughtspot/cs_tools/archive/v$(CS_TOOLS_VERSION).zip" + python -m pip install "cs_tools[cli] @ https://github.com/thoughtspot/cs_tools/archive/$(CS_TOOLS_VERSION).zip" # ENSURE SYNCER DEPENDENCIES ARE INSTALLED python -m pip install "snowflake-sqlalchemy >= 1.6.1" @@ -537,6 +544,7 @@ hide: - [`tools scriptability`][cst-tools-scriptability] rewritten to align to more with the [`tools git`][cst-tools-git] interface === ":bug:   Bugfix" + - Add `TS_SHARING_ACCESS.share_type (VARCHAR)` to [`tools searchable metadata`][cst-tools-searchable-metadata] - `DatabaseSyncers` which follow `PUT FILE -> COPY/MERGE INTO` workflow now support column header reording / redefinition - Column headers are now parsed appropriately on [__Excel Syncer__][cst-syncer-excel] ([#192](https://github.com/thoughtspot/cs_tools/pull/192)) - All `DATETIME` fields in extracted data are now converted to UTC, regardless of the Cluster's timezone @@ -569,6 +577,7 @@ hide: [cst-tools-assign-from-tag]: ../../generated/cli/reference.html#transfer [cst-tools-searchable-logs]: ../../generated/cli/reference.html#audit-logs [cst-tools-searchable-tml]: ../../generated/cli/reference.html#tml +[cst-tools-searchable-metadata]: ../../generated/cli/reference.html#metadata [cst-tools-scriptability]: ../../generated/cli/reference.html#scriptability [cst-tools-git]: ../../generated/cli/reference.html#git [cst-syncer-falcon]: ../../syncer/falcon diff --git a/docs/getting-started.md b/docs/getting-started.md index 5bb6433a..35d34108 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -131,7 +131,7 @@ Follow the steps below to get __CS Tools__ installed on your platform. # INSTALL A SPECIFIC VERSION OF cs_tools. - name: Install a pinned version of CS Tools - run: python -m pip install "cs_tools[cli] @ https://github.com/thoughtspot/cs_tools/archive/v${{ env.CS_TOOLS_VERSION }}.zip" + run: python -m pip install "cs_tools[cli] @ https://github.com/thoughtspot/cs_tools/archive/${{ env.CS_TOOLS_VERSION }}.zip" # ENSURE SYNCER DEPENDENCIES ARE INSTALLED. # found in: https://github.com/thoughtspot/cs_tools/blob/master/sync//MANIFEST.json @@ -190,7 +190,7 @@ Follow the steps below to get __CS Tools__ installed on your platform. - python -m pip install --upgrade pip # INSTALL A SPECIFIC VERSION OF cs_tools. - - python -m pip install "cs_tools[cli] @ https://github.com/thoughtspot/cs_tools/archive/v${CS_TOOLS_VERSION}.zip" + - python -m pip install "cs_tools[cli] @ https://github.com/thoughtspot/cs_tools/archive/${CS_TOOLS_VERSION}.zip" # ENSURE SYNCER DEPENDENCIES ARE INSTALLED. # found in: https://github.com/thoughtspot/cs_tools/blob/master/sync//MANIFEST.json @@ -220,7 +220,7 @@ Follow the steps below to get __CS Tools__ installed on your platform. # CS TOOLS IS COMMAND LINE LIBRARY WRAPPING TS APIS # https://thoughtspot.github.io/cs_tools/ - CS_TOOLS_VERSION: '1.6.0' + CS_TOOLS_VERSION: 'v1.6.0' CS_TOOLS_THOUGHTSPOT__URL: $(THOUGHTSPOT_URL) CS_TOOLS_THOUGHTSPOT__USERNAME: $(THOUGHTSPOT_USERNAME) CS_TOOLS_THOUGHTSPOT__SECRET_KEY: $(THOUGHTSPOT_SECRET_KEY) @@ -275,7 +275,7 @@ Follow the steps below to get __CS Tools__ installed on your platform. python -m pip install --upgrade pip # INSTALL A SPECIFIC VERSION OF cs_tools - python -m pip install "cs_tools[cli] @ https://github.com/thoughtspot/cs_tools/archive/v$(CS_TOOLS_VERSION).zip" + python -m pip install "cs_tools[cli] @ https://github.com/thoughtspot/cs_tools/archive/$(CS_TOOLS_VERSION).zip" # ENSURE SYNCER DEPENDENCIES ARE INSTALLED python -m pip install "snowflake-sqlalchemy >= 1.6.1"