1// Copyright (c) 2011 The LevelDB Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file. See the AUTHORS file for names of contributors.
4//
5// File names used by DB code
6
7#ifndef STORAGE_LEVELDB_DB_FILENAME_H_
8#define STORAGE_LEVELDB_DB_FILENAME_H_
9
10#include <stdint.h>
11#include <string>
12#include "leveldb/slice.h"
13#include "leveldb/status.h"
14#include "port/port.h"
15
16namespace leveldb {
17
18class Env;
19
20enum FileType {
21  kLogFile,
22  kDBLockFile,
23  kTableFile,
24  kDescriptorFile,
25  kCurrentFile,
26  kTempFile,
27  kInfoLogFile  // Either the current one, or an old one
28};
29
30// Return the name of the log file with the specified number
31// in the db named by "dbname".  The result will be prefixed with
32// "dbname".
33extern std::string LogFileName(const std::string& dbname, uint64_t number);
34
35// Return the name of the sstable with the specified number
36// in the db named by "dbname".  The result will be prefixed with
37// "dbname".
38extern std::string TableFileName(const std::string& dbname, uint64_t number);
39
40// Return the legacy file name for an sstable with the specified number
41// in the db named by "dbname". The result will be prefixed with
42// "dbname".
43extern std::string SSTTableFileName(const std::string& dbname, uint64_t number);
44
45// Return the name of the descriptor file for the db named by
46// "dbname" and the specified incarnation number.  The result will be
47// prefixed with "dbname".
48extern std::string DescriptorFileName(const std::string& dbname,
49                                      uint64_t number);
50
51// Return the name of the current file.  This file contains the name
52// of the current manifest file.  The result will be prefixed with
53// "dbname".
54extern std::string CurrentFileName(const std::string& dbname);
55
56// Return the name of the lock file for the db named by
57// "dbname".  The result will be prefixed with "dbname".
58extern std::string LockFileName(const std::string& dbname);
59
60// Return the name of a temporary file owned by the db named "dbname".
61// The result will be prefixed with "dbname".
62extern std::string TempFileName(const std::string& dbname, uint64_t number);
63
64// Return the name of the info log file for "dbname".
65extern std::string InfoLogFileName(const std::string& dbname);
66
67// Return the name of the old info log file for "dbname".
68extern std::string OldInfoLogFileName(const std::string& dbname);
69
70// If filename is a leveldb file, store the type of the file in *type.
71// The number encoded in the filename is stored in *number.  If the
72// filename was successfully parsed, returns true.  Else return false.
73extern bool ParseFileName(const std::string& filename,
74                          uint64_t* number,
75                          FileType* type);
76
77// Make the CURRENT file point to the descriptor file with the
78// specified number.
79extern Status SetCurrentFile(Env* env, const std::string& dbname,
80                             uint64_t descriptor_number);
81
82
83}  // namespace leveldb
84
85#endif  // STORAGE_LEVELDB_DB_FILENAME_H_
86