[GitHub] [skywalking-banyandb] HHoflittlefish777 commented on a diff in pull request #253: Write-ahead Logging interface

["HHoflittlefish777 (via GitHub)" <gi...@apache.org>]

HHoflittlefish777 commented on code in PR #253:
URL: https://github.com/apache/skywalking-banyandb/pull/253#discussion_r1111368902


##########
pkg/wal/wal.go:
##########
@@ -0,0 +1,46 @@
+// Licensed to Apache Software Foundation (ASF) under one or more contributor
+// license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright
+// ownership. Apache Software Foundation (ASF) licenses this file to you under
+// the Apache License, Version 2.0 (the "License"); you may
+// not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+// Package wal (Write-ahead logging) is an independent component to ensure data reliability.
+package wal
+
+// Log stands for a write-ahead logging instance.
+type Log struct{}
+
+// Options for Write-ahead Logging.
+type Options struct{}
+
+// Segment stands for a segment instance of Write-ahead log.
+type Segment struct{}
+
+// Wal include exposed interfaces.
+type Wal interface {
+	// New creates a Log instance in the specified root directory.
+	New(path string, opts *Options) (*Log, error)
+	// Write request to the WAL buffer.
+	// It will return synchronously when the request write in the WAL buffer,
+	// and trigger asynchronous callback when return when the buffer is flushed to disk successfully.
+	Write(data []byte) (func(), error)
+	// Read specified segment by index.
+	Read(index int) (*Segment, error)

Review Comment:
   Rotate can get detail of segment, index is the segment id.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org