installing-tigris-storage

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Installing Tigris Storage

安装Tigris Storage

Overview

概述

Tigris Storage is a high-performance object storage system for multi-cloud environments. This skill covers installation and configuration.

Tigris Storage是一款适用于多云环境的高性能对象存储系统。本技能涵盖其安装与配置流程。

Quick Setup

快速设置

1. Install the Package

1. 安装包

bash

npm install @tigrisdata/storage

bash

npm install @tigrisdata/storage

or

yarn add @tigrisdata/storage

undefined

yarn add @tigrisdata/storage

undefined

2. Create Account Resources

2. 创建账户资源

Create Tigris account: https://storage.new
Create bucket: https://console.tigris.dev/createbucket
Create access key: https://console.tigris.dev/createaccesskey

创建Tigris账户：https://storage.new
创建存储桶：https://console.tigris.dev/createbucket
创建访问密钥：https://console.tigris.dev/createaccesskey

3. Configure the Environment

3. 配置环境

Create

.env

in project root:

bash

TIGRIS_STORAGE_ACCESS_KEY_ID=tid_access_key_id
TIGRIS_STORAGE_SECRET_ACCESS_KEY=tsec_secret_access_key
TIGRIS_STORAGE_BUCKET=bucket_name

在项目根目录创建

.env

文件：

bash

TIGRIS_STORAGE_ACCESS_KEY_ID=tid_access_key_id
TIGRIS_STORAGE_SECRET_ACCESS_KEY=tsec_secret_access_key
TIGRIS_STORAGE_BUCKET=bucket_name

Quick Reference

快速参考

Variable	Purpose	Required
`TIGRIS_STORAGE_ACCESS_KEY_ID`	Authentication key ID	Yes
`TIGRIS_STORAGE_SECRET_ACCESS_KEY`	Authentication secret	Yes
`TIGRIS_STORAGE_BUCKET`	Default bucket name	Yes (can override)

变量名称	用途	是否必填
`TIGRIS_STORAGE_ACCESS_KEY_ID`	身份验证密钥ID	是
`TIGRIS_STORAGE_SECRET_ACCESS_KEY`	身份验证密钥	是
`TIGRIS_STORAGE_BUCKET`	默认存储桶名称	是（可覆盖）

Per-Request Configuration

单请求配置

All methods accept optional config to override environment variables:

typescript

import { list } from "@tigrisdata/storage";

// Use environment defaults
const result = await list();

// Override bucket
const result = await list({
  config: { bucket: "different-bucket" },
});

// Override all config
const result = await list({
  config: {
    bucket: "my-bucket",
    accessKeyId: "key",
    secretAccessKey: "secret",
  },
});

所有方法均接受可选配置，以覆盖环境变量：

typescript

import { list } from "@tigrisdata/storage";

// 使用环境默认配置
const result = await list();

// 覆盖存储桶
const result = await list({
  config: { bucket: "different-bucket" },
});

// 覆盖全部配置
const result = await list({
  config: {
    bucket: "my-bucket",
    accessKeyId: "key",
    secretAccessKey: "secret",
  },
});

Common Mistakes

常见错误

Mistake	Fix
Missing `.env` file	Create it in project root
Wrong bucket name	Verify at console.tigris.dev
Access key not working	Regenerate at console.tigris.dev/createaccesskey

错误类型	修复方法
缺少 `.env` 文件	在项目根目录创建该文件
存储桶名称错误	在console.tigris.dev上验证名称
访问密钥无法使用	在console.tigris.dev/createaccesskey重新生成密钥

Next Steps

后续步骤

After installation:

Use tigris-object-operations to get, put, delete, and list objects
Use tigris-bucket-management for bucket CRUD operations
Use tigris-snapshots-forking for version control and forking

完成安装后：

使用tigris-object-operations执行对象的获取、上传、删除及列举操作
使用tigris-bucket-management进行存储桶的增删改查操作
使用tigris-snapshots-forking进行版本控制与分支操作