hanahmily commented on code in PR #253: URL: https://github.com/apache/skywalking-banyandb/pull/253#discussion_r1112399760
########## 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 + +// Options for Write-ahead Logging. +type Options struct{} + +// Segment stands for a segment instance of Write-ahead log. +type Segment interface{} + +// WAL includes exposed interfaces. +type WAL interface { + // 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. Review Comment: ```suggestion // Read specified segment by SegmentID. ``` ########## 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 + +// Options for Write-ahead Logging. +type Options struct{} + +// Segment stands for a segment instance of Write-ahead log. +type Segment interface{} + +// WAL includes exposed interfaces. +type WAL interface { + // 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) + // ReadAllSegments operation reads all segments. + ReadAllSegments() ([]*Segment, error) + // Rotate closes the open segment and opens a new one, returning the closed segment details. + Rotate() (*Segment, error) + // Delete the specified segment. + Delete(index int) error +} + +// New creates a Log instance in the specified root directory. +func New(_ string, _ *Options) (*WAL, error) { Review Comment: ```suggestion func New(_ string, _ Options) (WAL, error) { ``` ########## 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 + +// Options for Write-ahead Logging. +type Options struct{} + +// Segment stands for a segment instance of Write-ahead log. +type Segment interface{} + +// WAL includes exposed interfaces. +type WAL interface { + // 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. Review Comment: ```suggestion // Write a logging entity. // It will return immediately when the data is written in the buffer, // The returned function will be called when the entity is flushed on the persistent storage. ``` ########## 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 + +// Options for Write-ahead Logging. +type Options struct{} + +// Segment stands for a segment instance of Write-ahead log. +type Segment interface{} + +// WAL includes exposed interfaces. +type WAL interface { + // 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) + // ReadAllSegments operation reads all segments. + ReadAllSegments() ([]*Segment, error) + // Rotate closes the open segment and opens a new one, returning the closed segment details. + Rotate() (*Segment, error) + // Delete the specified segment. + Delete(index int) error +} + +// New creates a Log instance in the specified root directory. Review Comment: ```suggestion // New creates a WAL instance in the specified path. ``` ########## 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 + +// Options for Write-ahead Logging. +type Options struct{} + +// Segment stands for a segment instance of Write-ahead log. +type Segment interface{} + +// WAL includes exposed interfaces. Review Comment: ```suggestion // WAL denotes a Write-ahead logging. // Modules who want their data reliable could write data to an instance of WAL. // A WAL combines several segments, ingesting data on a single opened one. // Rotating the WAL will create a new segment, marking it as opened and persisting previous segments on the disk. ``` ########## 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 + +// Options for Write-ahead Logging. +type Options struct{} + +// Segment stands for a segment instance of Write-ahead log. +type Segment interface{} + +// WAL includes exposed interfaces. +type WAL interface { + // 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) + // ReadAllSegments operation reads all segments. Review Comment: ```suggestion // ReadAllSegments reads all segments sorted by their creation time in ascending order. ``` ########## 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: Would you add a method to Segment to return such ID? It's better to define a customized SegmentID type instead of an integer one. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
