docs(connectors): add Looker Studio Data API + Columnar readmes #64
Conversation
… Columnar as views-only and add Capella view setup - Add detailed Data API readme: PATH_USER_PASS auth, collection vs custom SQL++ modes, schema inference (INFER + fallback), limits, troubleshooting - Rewrite Columnar readme as views-only: required Capella view creation steps with SQL++ example, links to docs; remove collection/custom query modes; add future scope note (collections prototype) - Standardize tutorial frontmatter across both readmes Files: - couchbase-tutorials/tutorial/markdown/connectors/looker-studio/dataapi/readme.md - couchbase-tutorials/tutorial/markdown/connectors/looker-studio/columnar/readme.md
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @teetangh, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request adds two new documentation readmes for connecting Google Looker Studio to Couchbase. One readme details connecting to Couchbase Columnar, emphasizing a views-only approach and providing steps for creating views in Capella. The other readme covers connecting via the Couchbase Data API, outlining methods for querying by collection or using custom SQL++ queries. Both documents standardize frontmatter and include comprehensive guides on authentication, configuration, schema inference, data retrieval, best practices, and troubleshooting.
Highlights
- New Looker Studio Data API Readme: Introduces a comprehensive guide for connecting Looker Studio to Couchbase via the Data API, covering authentication, querying by collection or custom SQL++, schema inference, and troubleshooting.
- Updated Looker Studio Columnar Readme: Rewrites the Columnar connector documentation to focus exclusively on a views-only approach, including detailed steps for creating Capella views with SQL++ examples and clarifying that direct collection/custom query modes are not supported.
- Standardized Documentation Structure: Ensures consistent frontmatter and tutorial structure across both new Looker Studio connector readmes for improved readability and navigation.
- Clarification of Columnar Connector Scope: Explicitly states that the Columnar connector is views-only, does not support direct collection queries or custom queries, and notes future scope for collections prototype.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
teetangh
changed the title
There was a problem hiding this comment.
Code Review
This pull request introduces documentation for two new Looker Studio connectors, one for Couchbase Columnar (views-only) and another for the Data API. The new readme.md files are well-structured and provide a good overview for users. My review includes a few suggestions to improve clarity and correctness, mainly related to SQL++ examples and consistent terminology to ensure the documentation is as accurate and easy to follow as possible.
teetangh
changed the title
- Change SDK language from JavaScript to Node.js in both readmes. - Clarify prerequisites and instructions in the Columnar readme by removing references to Collections. - Update the Data API readme to enhance clarity in SQL++ query descriptions and schema inference details. Files: - tutorial/markdown/connectors/looker-studio/dataapi/readme.md - tutorial/markdown/connectors/looker-studio/columnar/readme.md
…ics Views (TAVs) - Revised title and description to specify TAVs instead of views. - Updated instructions and prerequisites to clarify the use of TAVs in Capella. - Adjusted sections throughout the document to consistently reference TAVs for improved clarity. Files: - tutorial/markdown/connectors/looker-studio/columnar/readme.md
- Increased the maximum allowed title length from 72 to 100 characters for better flexibility. - Added new tags related to Looker Studio and data connectors to enhance categorization. Files: - test/test-markdown-frontmatter.js
… query support - Updated title and overview to clarify the connection process between Looker Studio and Couchbase Columnar using Tabular Analytics Views (TAVs). - Expanded instructions for creating TAVs and added a new section for custom SQL++ queries, including requirements and examples. - Improved clarity in troubleshooting tips and best practices for using TAVs with Looker Studio. Files: - tutorial/markdown/connectors/looker-studio/columnar/readme.md
- Changed the short title to "Columnar Looker Studio Connector" for improved specificity. - Adjusted the description to remove redundancy while maintaining clarity about the connection process using Tabular Analytics Views (TAVs). Files: - tutorial/markdown/connectors/looker-studio/columnar/readme.md
…mitations and troubleshooting tips - Added a section detailing schema inference limitations, including issues with mixed data types, incomplete sampling, and nested object depth. - Expanded troubleshooting section with specific guidance on authentication errors, schema inference problems, and query issues. - Improved best practices for data structure and query execution to optimize schema inference and performance. Files: - tutorial/markdown/connectors/looker-studio/dataapi/readme.md
…configuration visuals - Added images for the authentication screen, database scope view configuration, field customization, and report creation in Looker Studio. - Expanded instructions to guide users through the setup process after adding the Couchbase Columnar connector. - Improved clarity on the steps required to create reports using TAV-backed fields. Files: - tutorial/markdown/connectors/looker-studio/columnar/readme.md
…or setup information - Revised the prerequisites section to replace the outdated Couchbase Columnar setup link with the current link to the Couchbase Analytics product page. - Ensured clarity and accuracy in the documentation for users setting up the connector. Files: - tutorial/markdown/connectors/looker-studio/columnar/readme.md
Files: