Choose between local development and VS Code workspaces（在本地开发与 VS Code 工作区之间进行选择）¶
When working with VS Code in Foundry, you can choose between two developer environment options: use VS Code workspaces deployed on Palantir infrastructure, or install the Palantir extension in your local VS Code application. This guide helps you understand the differences and choose the right option for your needs.
Quick comparison¶
| VS Code workspaces | Palantir extension for local development | |
|---|---|---|
| Setup | No installation required; select Open in VS Code | Download and install the extension locally |
| Environment | Deployed on Palantir infrastructure | Runs on your local machine |
| Data handling | Data stays on platform (except for displayed preview results) | Streams data to local memory during preview |
| Access requirements | Code Workspaces enabled | Administrator approval plus download permissions |
| Third-party extensions | Not supported | Supported (if allowed by your organization) |
Option: VS Code workspaces¶
Best for the following:
- Getting started quickly: No installation or configuration needed; open your repository and start coding.
- Sensitive data workflows: Data remains on Palantir infrastructure during development, with strict security controls.
- Teams requiring consistent environments: Everyone works in the same standardized environment.
- Users without download permissions: Preview transforms without needing download operations on datasets.
Option: Palantir extension for local development¶
Best for the following:
- Developers who prefer local workflows: Work with your existing local setup and familiar tools.
- Using third-party tools and extensions: Access the full VS Code extension marketplace (if allowed by your organization).
- Custom development environments: Full control over your IDE configuration and installed tools.
Requirements:
- Platform administrator must enable local preview in Control Panel.
- You must have download permissions (
s3-proxy:datasets-readandapi:datasets-read) on all input datasets. - These are privileged operations that allow downloading entire datasets locally.
Data security¶
VS Code workspaces¶
Data handling: Data remains on Palantir infrastructure during development. Only preview results (up to 1000 rows) are displayed in the results table. No input datasets are streamed to your machine.
Security controls: Strict access controls and audit logging are maintained. No risk of accidental data leakage to local machines.
Palantir extension for local development¶
Review our documentation on security considerations for local development.
If you are unsure which option is best for you, we recommend starting with VS Code workspaces. This option requires no setup and maintains the strictest security controls. You can always switch to local development later if you need additional flexibility.
Getting started¶
VS Code workspaces¶
- Open a supported repository in VS Code.
- From code repositories, you can select Open in VS Code in the upper right corner (shown for supported repositories).
- At the time of creating a new repository, selecting VS Code will automatically bring you into a VS Code workspace.
- Your environment is ready, and you can start coding.
Palantir extension for local development¶
- Verify with your administrator that local preview is enabled.
- Ensure you have the necessary download permissions on your datasets.
- Download and install the Palantir extension.
- Clone your repository and start developing.
For detailed local preview setup instructions (including Java transforms), review our documentation on previewing transforms in local development.
For more information, review additional documentation:
- VS Code workspaces overview
- Palantir extension for Visual Studio Code
- Security considerations for local development
中文翻译¶
在本地开发与 VS Code 工作区之间进行选择¶
在 Foundry 中使用 VS Code 时，您可以在两种开发者环境选项之间进行选择：使用部署在 Palantir 基础设施上的 VS Code 工作区（VS Code workspaces），或在本地 VS Code 应用程序中安装 Palantir 扩展（Palantir extension）。本指南将帮助您了解两者的差异，并根据需求选择最合适的选项。
快速对比¶
| VS Code 工作区 | 用于本地开发的 Palantir 扩展 | |
|---|---|---|
| 设置 | 无需安装；选择 在 VS Code 中打开 | 在本地下载并安装扩展 |
| 环境 | 部署在 Palantir 基础设施上 | 在本地机器上运行 |
| 数据处理 | 数据保留在平台上（显示的预览结果除外） | 预览期间将数据流式传输到本地内存 |
| 访问要求 | 已启用代码工作区 | 需管理员批准并拥有下载权限 |
| 第三方扩展 | 不支持 | 支持（若组织允许） |
选项：VS Code 工作区¶
最适合以下场景：
- 快速上手： 无需安装或配置；打开您的仓库即可开始编码。
- 敏感数据工作流： 开发期间数据保留在 Palantir 基础设施上，具有严格的安全控制。
- 需要统一环境的团队： 每个人都在相同的标准化环境中工作。
- 没有下载权限的用户： 无需对数据集执行下载操作即可预览转换（transforms）。
选项：用于本地开发的 Palantir 扩展¶
最适合以下场景：
- 偏好本地工作流的开发者： 使用您现有的本地设置和熟悉的工具。
- 使用第三方工具和扩展： 访问完整的 VS Code 扩展市场（若组织允许）。
- 自定义开发环境： 完全控制您的 IDE 配置和已安装工具。
要求：
- 平台管理员必须在控制面板中启用本地预览（local preview）。
- 您必须对所有输入数据集拥有下载权限（
s3-proxy:datasets-read和api:datasets-read）。 - 这些是特权操作，允许在本地下载整个数据集。
数据安全¶
VS Code 工作区¶
数据处理： 开发期间数据保留在 Palantir 基础设施上。只有预览结果（最多 1000 行）会显示在结果表中。没有输入数据集会流式传输到您的机器。
安全控制： 保持严格的访问控制和审计日志记录。不存在数据意外泄露到本地机器的风险。
用于本地开发的 Palantir 扩展¶
请查阅我们关于本地开发安全注意事项的文档。
如果您不确定哪个选项最适合您，我们建议从 VS Code 工作区开始。此选项无需设置，并保持最严格的安全控制。如果您日后需要更多灵活性，随时可以切换到本地开发。
开始使用¶
VS Code 工作区¶
- 在 VS Code 中打开一个受支持的仓库。
- 在代码仓库中，您可以选择右上角的 在 VS Code 中打开（适用于受支持的仓库）。
- 在创建新仓库时，选择 VS Code 将自动将您带入 VS Code 工作区。
- 您的环境已准备就绪，可以开始编码。
用于本地开发的 Palantir 扩展¶
- 与管理员确认本地预览已启用。
- 确保您对数据集拥有必要的下载权限。
- 下载并安装 Palantir 扩展。
- 克隆您的仓库并开始开发。
有关详细的本地预览设置说明（包括 Java 转换），请查阅我们关于在本地开发中预览转换的文档。
如需更多信息，请查阅其他文档：