Win32 API 日本語リファレンス
ホーム › Storage.Jet › JetBeginTransaction

JetBeginTransaction

関数
現在のセッションでトランザクションを開始する。
DLLESENT.dll呼出規約winapi

シグネチャ

// ESENT.dll
#include <windows.h>

INT JetBeginTransaction(
    JET_SESID sesid
);

パラメーター

名前型方向説明
sesidJET_SESIDinトランザクションを開始するセッションを識別するJET_SESIDハンドル。同一セッション内でネスト可能である。

戻り値の型: INT

公式ドキュメント

JetBeginTransaction 関数は、セッションをトランザクション状態に移行させ、新しいセーブポイントを作成します。この関数は 1 つのセッションに対して複数回呼び出すことができ、その場合はセーブポイントが追加で作成されます。これらのセーブポイントを使用して、データベースの状態に対する変更を選択的に保持または破棄できます。

戻り値

この関数は JET_ERR データ型を返し、その値は次のいずれかの戻り値コードです。発生し得る ESE のエラーの詳細については、「Extensible Storage Engine のエラー」および「エラー処理パラメーター」を参照してください。

戻り値コード

説明

JET_errSuccess

操作は正常に完了しました。

JET_errClientRequestToStopJetService

JetStopService の呼び出しにより、そのセッションに関連付けられたインスタンス上のすべての処理が停止しているため、操作を完了できません。

JET_errInstanceUnavailable

そのセッションに関連付けられたインスタンスで、データの整合性を保護するためにすべてのデータへのアクセスを取り消す必要がある致命的なエラーが発生したため、操作を完了できません。

このエラーは Windows XP 以降のリリースでのみ返されます。

JET_errNotInitialized

そのセッションに関連付けられたインスタンスがまだ初期化されていないため、操作を完了できません。

JET_errRestoreInProgress

そのセッションに関連付けられたインスタンスで復元操作が進行中であるため、操作を完了できません。

JET_errSessionSharingViolation

同じセッションを同時に複数のスレッドで使用することはできません。このエラーは Windows XP 以降のリリースでのみ返されます。

JET_errTermInProgress

そのセッションに関連付けられたインスタンスがシャットダウン中であるため、操作を完了できません。

JET_errTransTooDeep

セッションがデータベースエンジンで許容される最大のセーブポイント深度に既に達しているため、新しいトランザクションを開始できません。

成功した場合、指定したセッションはトランザクション内に入ります。そのセッションが既にトランザクション内にあった場合は、新しいセーブポイントが作成されます。

失敗した場合、セッションのトランザクション状態は変更されません。データベースの状態も変化しません。

解説

データベースエンジンは、トランザクションに対してスナップショット分離モデルを提供します。つまり、セッションが最初にトランザクション状態に入ると、そのセッションはトランザクション開始時点で凍結されたデータベース全体を参照します。セッションは常に適切なバージョンのデータにアクセスできるため、データに読み取りロックをかける必要がありません。これは、データを更新中のセッションが、そのデータを読み取る別のセッションをブロックすることは決してないことを意味します。

スナップショット分離を使用することのもう 1 つの帰結は、更新時に使用されるロックモデルです。データベースエンジンは、あるデータに対する書き込みロックを、最初に要求したセッションに与えます。この書き込みロックは、トランザクションがコミットまたは完全に中止され、そのセッションがトランザクション内でなくなった時点で解放されます。あるセッションが書き込みロックを保持している間に、別のセッションが同じ書き込みロックを要求した場合、そのセッションは書き込みロックが利用可能になるまでブロックされることはありません。代わりに、2 番目のセッションは直ちに JET_errWriteConflict で失敗します。この競合を解決するには、2 番目のセッションは自身のトランザクションを完全に中止 (またはコミット) し、最初のセッションがトランザクションをコミットまたは中止するまで短い時間待機してから、最初からやり直す必要があります。

スナップショット分離をサポートするために、データベースエンジンは、いずれかのセッションで最も古いアクティブなトランザクションが開始された時点以降に変更されたすべてのデータのすべてのバージョンをメモリに保持します。これはアプリケーションにとって重要な意味を持ちます。大量のバージョンがメモリ上に蓄積されるような動作は、インスタンスがバージョンストアの最大サイズを使い果たす原因になり得ます (詳細については、「システムパラメーター」の JET_paramMaxVerPages を参照してください)。そのような動作には、単一トランザクション内での非常に大量の更新や、非常に長時間実行されるトランザクションなどが含まれます (これらに限りません)。したがって、アプリケーションで想定されるトランザクション負荷に合わせてバージョンストアのサイズを適切に構成することが非常に重要です。また、単一のトランザクションで実行する更新の数を制限するよう十分に注意することも重要です。さらに、高負荷のシナリオでは、トランザクションの実行時間をできる限り短くすることが重要です。

データの取得や更新を行う ESE API を呼び出す際には、アプリケーションは常にトランザクションのコンテキスト内にあることを強くお勧めします。そうしない場合、データベースエンジンはこの種の ESE API 呼び出しをアプリケーションに代わって個別にトランザクションで囲みます。これらの非常に短いトランザクションのコストは、場合によっては急速に積み重なります。

エンジンの既定の動作では、JetBeginTransaction が最初に呼び出された時点から、対応する JetCommitTransaction または JetRollback の呼び出しが行われる時点まで、セッションの使用が同じスレッドに限定されます。この動作は、JetSetSessionContext および JetResetSessionContext を使用してカスタムのセッションコンテキストを設定することで、この制限を解除するように変更できます。

データベースエンジンは、トランザクションによるスキーマ変更もサポートします。たとえば、新しいトランザクションを開始し、テーブルを作成し、いくつかの列を追加し、1 つか 2 つのインデックスを作成した後で、そのトランザクションを中止することができます。この場合、追加したばかりのスキーマ要素はデータベースから削除されます。また、同じトランザクション内でスキーマ変更と通常のデータベース更新を混在させることもできます。

要件

要件 値

クライアント

Windows Vista、Windows XP、または Windows 2000 Professional が必要です。

サーバー

Windows Server 2008、Windows Server 2003、または Windows 2000 Server が必要です。

ヘッダー

Esent.h で宣言されています。

ライブラリ

ESENT.lib を使用します。

DLL

ESENT.dll が必要です。

関連項目

JET_ERR
JET_GRBIT
JET_SESID
JetCommitTransaction
JetGetSystemParameter
JetResetSessionContext
JetRollback
JetSetSessionContext
JetStopService
システムパラメーター

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp)

各言語での呼び出し定義

// ESENT.dll
#include <windows.h>

INT JetBeginTransaction(
    JET_SESID sesid
);
[DllImport("ESENT.dll", ExactSpelling = true)]
static extern int JetBeginTransaction(
    UIntPtr sesid   // JET_SESID
);
<DllImport("ESENT.dll", ExactSpelling:=True)>
Public Shared Function JetBeginTransaction(
    sesid As UIntPtr   ' JET_SESID
) As Integer
End Function
' sesid : JET_SESID
Declare PtrSafe Function JetBeginTransaction Lib "esent" ( _
    ByVal sesid As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

JetBeginTransaction = ctypes.windll.esent.JetBeginTransaction
JetBeginTransaction.restype = ctypes.c_int
JetBeginTransaction.argtypes = [
    ctypes.c_size_t,  # sesid : JET_SESID
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ESENT.dll')
JetBeginTransaction = Fiddle::Function.new(
  lib['JetBeginTransaction'],
  [
    Fiddle::TYPE_UINTPTR_T,  # sesid : JET_SESID
  ],
  Fiddle::TYPE_INT)
#[link(name = "esent")]
extern "system" {
    fn JetBeginTransaction(
        sesid: usize  // JET_SESID
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ESENT.dll")]
public static extern int JetBeginTransaction(UIntPtr sesid);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ESENT_JetBeginTransaction' -Namespace Win32 -PassThru
# $api::JetBeginTransaction(sesid)
#uselib "ESENT.dll"
#func global JetBeginTransaction "JetBeginTransaction" sptr
; JetBeginTransaction sesid   ; 戻り値は stat
; sesid : JET_SESID -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ESENT.dll"
#cfunc global JetBeginTransaction "JetBeginTransaction" sptr
; res = JetBeginTransaction(sesid)
; sesid : JET_SESID -> "sptr"
; INT JetBeginTransaction(JET_SESID sesid)
#uselib "ESENT.dll"
#cfunc global JetBeginTransaction "JetBeginTransaction" intptr
; res = JetBeginTransaction(sesid)
; sesid : JET_SESID -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	esent = windows.NewLazySystemDLL("ESENT.dll")
	procJetBeginTransaction = esent.NewProc("JetBeginTransaction")
)

// sesid (JET_SESID)
r1, _, err := procJetBeginTransaction.Call(
	uintptr(sesid),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function JetBeginTransaction(
  sesid: NativeUInt   // JET_SESID
): Integer; stdcall;
  external 'ESENT.dll' name 'JetBeginTransaction';
result := DllCall("ESENT\JetBeginTransaction"
    , "UPtr", sesid   ; JET_SESID
    , "Int")   ; return: INT
●JetBeginTransaction(sesid) = DLL("ESENT.dll", "int JetBeginTransaction(int)")
# 呼び出し: JetBeginTransaction(sesid)
# sesid : JET_SESID -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "esent" fn JetBeginTransaction(
    sesid: usize // JET_SESID
) callconv(std.os.windows.WINAPI) i32;
proc JetBeginTransaction(
    sesid: uint  # JET_SESID
): int32 {.importc: "JetBeginTransaction", stdcall, dynlib: "ESENT.dll".}
pragma(lib, "esent");
extern(Windows)
int JetBeginTransaction(
    size_t sesid   // JET_SESID
);
ccall((:JetBeginTransaction, "ESENT.dll"), stdcall, Int32,
      (Csize_t,),
      sesid)
# sesid : JET_SESID -> Csize_t
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t JetBeginTransaction(
    uintptr_t sesid);
]]
local esent = ffi.load("esent")
-- esent.JetBeginTransaction(sesid)
-- sesid : JET_SESID
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ESENT.dll');
const JetBeginTransaction = lib.func('__stdcall', 'JetBeginTransaction', 'int32_t', ['uintptr_t']);
// JetBeginTransaction(sesid)
// sesid : JET_SESID -> 'uintptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ESENT.dll", {
  JetBeginTransaction: { parameters: ["usize"], result: "i32" },
});
// lib.symbols.JetBeginTransaction(sesid)
// sesid : JET_SESID -> "usize"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t JetBeginTransaction(
    size_t sesid);
C, "ESENT.dll");
// $ffi->JetBeginTransaction(sesid);
// sesid : JET_SESID
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Esent extends StdCallLibrary {
    Esent INSTANCE = Native.load("esent", Esent.class);
    int JetBeginTransaction(
        long sesid   // JET_SESID
    );
}
@[Link("esent")]
lib LibESENT
  fun JetBeginTransaction = JetBeginTransaction(
    sesid : LibC::SizeT   # JET_SESID
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef JetBeginTransactionNative = Int32 Function(UintPtr);
typedef JetBeginTransactionDart = int Function(int);
final JetBeginTransaction = DynamicLibrary.open('ESENT.dll')
    .lookupFunction<JetBeginTransactionNative, JetBeginTransactionDart>('JetBeginTransaction');
// sesid : JET_SESID -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function JetBeginTransaction(
  sesid: NativeUInt   // JET_SESID
): Integer; stdcall;
  external 'ESENT.dll' name 'JetBeginTransaction';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "JetBeginTransaction"
  c_JetBeginTransaction :: CUIntPtr -> IO Int32
-- sesid : JET_SESID -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let jetbegintransaction =
  foreign "JetBeginTransaction"
    (size_t @-> returning int32_t)
(* sesid : JET_SESID -> size_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library esent (t "ESENT.dll"))
(cffi:use-foreign-library esent)

(cffi:defcfun ("JetBeginTransaction" jet-begin-transaction :convention :stdcall) :int32
  (sesid :uint64))   ; JET_SESID
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $JetBeginTransaction = Win32::API::More->new('ESENT',
    'int JetBeginTransaction(WPARAM sesid)');
# my $ret = $JetBeginTransaction->Call($sesid);
# sesid : JET_SESID -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API