Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add implement section for the services #46

Merged
merged 3 commits into from
Apr 29, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/go-storage/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ An application-oriented unified storage layer for Golang.
- [Appender](operations/appender): allow appending to an object
- [Block](operations/blocker): allow combining an object with block ids
- [Page](operations/pager): allow doing random writes
- [Fetcher](operations/fetch.md): fetch from a given url to path

## Quick Start

Expand Down
1 change: 1 addition & 0 deletions docs/go-storage/operations/appender/commit_append.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
`commit_append` is used to finish an append procedure.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

commit_append may bed added in a new proposal, please don't include it in this PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it. And the appender support in go-storage-dropbox depends on this operation, do I need to remove Appender from the implementation section temporarily?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please wait my proposal and you don't need to remove it.

1 change: 1 addition & 0 deletions docs/go-storage/operations/appender/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ title: Introduction

- Use [create_append](./create_append.md) to create an appendable object.
- Use [write_append](./write_append.md) to write data into the object.
- Use [commit_append](./commit_append.md) to finish an append procedure.
- Use [read](../storager/read.md) to read data from the object.
5 changes: 5 additions & 0 deletions docs/go-storage/operations/fetch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Fetcher
---

`Fetcher` is used to fetch from a given url to path.
12 changes: 12 additions & 0 deletions docs/go-storage/services/azblob.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,16 @@ name: <container_name>
work_dir: /<work_dir>
```

## Implementation

This service implements following interfaces:

- [Servicer](../operations/servicer/index.md)

- [Storager](../operations/storager/index.md)

- [Appender](../operations/appender/index.md)

## Pairs

### Server-Side Encryption (SSE)
Expand All @@ -58,3 +68,5 @@ Refer to https://docs.microsoft.com/en-us/azure/storage/common/storage-service-e
- [Read](../operations/storager/read.md)
- [Stat](../operations/storager/stat.md)
- [Write](../operations/storager/write.md)
- [CreateAppend](../operations/appender/create_append.md)
- [WriteAppend](../operations/appender/write_append.md)
7 changes: 7 additions & 0 deletions docs/go-storage/services/cos.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,13 @@ work_dir: /<work_dir>
location: <bucket_location>
```

## Implementation

This service implements following interfaces:

- [Servicer](../operations/servicer/index.md)

- [Storager](../operations/storager/index.md)

## Pairs

Expand Down
8 changes: 8 additions & 0 deletions docs/go-storage/services/dropbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,11 @@
| ---- | -------- | -------- |
| [credential](go-storage/pairs/credential.md) | Y | only support `api_key` protocol |
| [work_dir](go-storage/pairs/work_dir.md) | N | work dir |

## Implementation

This service implements following interfaces:

- [Storager](../operations/storager/index.md)

- [Appender](../operations/appender/index.md)
2 changes: 1 addition & 1 deletion docs/go-storage/services/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ work_dir: /<work_dir>

## Implementation

This service implement following interfaces:
This service implements following interfaces:

- [Storager](../operations/storager/index.md)
- [Copier](../operations/copy.md)
Expand Down
8 changes: 8 additions & 0 deletions docs/go-storage/services/gcs.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,14 @@ work_dir: /<work_dir>
project: <google_cloud_project_id>
```

## Implementation

This service implements following interfaces:

- [Servicer](../operations/servicer/index.md)

- [Storager](../operations/storager/index.md)

## Pairs

### Server-Side Encryption (SSE)
Expand Down
7 changes: 7 additions & 0 deletions docs/go-storage/services/kodo.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,10 @@ work_dir: /<work_dir>
endpoint: http:<domain>
```

## Implementation

This service implements following interfaces:

- [Servicer](../operations/servicer/index.md)

- [Storager](../operations/storager/index.md)
14 changes: 13 additions & 1 deletion docs/go-storage/services/oss.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,16 @@ work_dir: /<work_dir>
location: <bucket_location>
```

## Implementation

This service implements following interfaces:

- [Servicer](../operations/servicer/index.md)

- [Storager](../operations/storager/index.md)

- [Appender](../operations/appender/index.md)

## Pairs

### Server-Side Encryption (SSE)
Expand All @@ -61,6 +71,7 @@ For global users, refer to https://www.alibabacloud.com/help/doc-detail/31871.ht
##### Supported Operations

- [Write](../operations/storager/write.md)
- [CreateAppend](../operations/appender/create_append.md)

#### SSE-OSS

Expand All @@ -70,4 +81,5 @@ For global users, refer to https://www.alibabacloud.com/help/doc-detail/31871.ht

##### Supported Operations

- [Write](../operations/storager/write.md)
- [Write](../operations/storager/write.md)
- [CreateAppend](../operations/appender/create_append.md)
20 changes: 20 additions & 0 deletions docs/go-storage/services/qingstor.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,26 @@ if err != nil {
}
```

## Implementation

This service implements following interfaces:

- [Servicer](../operations/servicer/index.md)

- [Storager](../operations/storager/index.md)

- [Appender](../operations/appender/index.md)

- [Copier](../operations/copy.md)

- [Fetcher](../operations/fetch.md)

- [Mover](../operations/move.md)

- [Multiparter](../operations/multiparter/index.md)

- [Reacher](../operations/reach.md)

## Pairs

### Server-Side Encryption (SSE)
Expand Down
10 changes: 10 additions & 0 deletions docs/go-storage/services/s3.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,16 @@ work_dir: /<work_dir>
location: <bucket_location>
```

## Implementation

This service implements following interfaces:

- [Servicer](../operations/servicer/index.md)

- [Storager](../operations/storager/index.md)

- [Multiparter](../operations/multiparter/index.md)

## Pairs

### Server-Side Encryption (SSE)
Expand Down
6 changes: 6 additions & 0 deletions docs/go-storage/services/uss.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,9 @@ name: <bucket_name>
work_dir: /<work_dir>
endpoint: https:<domain>
```

## Implementation

This service implements following interfaces:

- [Storager](../operations/storager/index.md)