core/sql/arkcmp/CmpSqlSession.h

/**********************************************************************
// @@@ START COPYRIGHT @@@
//
// Licensed to the 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.  The 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.
//
// @@@ END COPYRIGHT @@@
**********************************************************************/
/* -*-C++-*-
 *****************************************************************************
 *
 * File:         CmpSqlSession.h
 * Description:
 *
 * Created:      6/6/2006
 * Language:     C++
 *
 *
 *
 *
 *****************************************************************************
 */
#ifndef CMPSQLSESSION_H
#define CMPSQLSESSION_H

#include "NABoolean.h"
#include "NAStringDef.h"
#include "ObjectNames.h"
#include "ComSqlId.h"

class CmpSqlSession : public NABasicObject
{
public:
  CmpSqlSession(NAHeap * heap);

  ~CmpSqlSession();

  // Validates that the input schema or table name is a valid
  // volatile name.
  // Validation is if it doesn't contain the reserved
  // volatile name prefix, is not more than 2 parts, and
  // contains the current user name if a 2-part name.
  // All validate methods return TRUE is valid, FALSE otherwise.
  // CmpCommon::diags is set in case of invalidation.
  NABoolean isValidVolatileSchemaName(NAString &schName);
  NABoolean validateVolatileSchemaName(NAString &schName);
  NABoolean validateVolatileQualifiedSchemaName(QualifiedName &inName);
  NABoolean validateVolatileQualifiedName(QualifiedName &inName);
  NABoolean validateVolatileCorrName(CorrName &corrName);
  NABoolean validateVolatileName(const char * name);

  QualifiedName * updateVolatileQualifiedName(QualifiedName &inName);
  QualifiedName * updateVolatileQualifiedName(const NAString &inName);
  CorrName getVolatileCorrName(CorrName &corrName);
  SchemaName * updateVolatileSchemaName();


  void setSessionId(NAString &sessionID);

  const NAString &getSessionId() {return sessionID_;}

  void setSessionUsername(NAString &userName);

  NAString &getDatabaseUserName() { return databaseUserName_; }
  Int32 &getDatabaseUserID() { return databaseUserID_; }

  Lng32 setDatabaseUser(Int32 userID, const char *userName);

  NAString &volatileSchemaName() { return volatileSchemaName_;}
  void setVolatileSchemaName(NAString &volatileSchemaName);

  NAString &volatileCatalogName() { return volatileCatalogName_;}
  void setVolatileCatalogName(NAString &volatileCatalogName,
			      NABoolean noSegmentAppend = FALSE);

  NABoolean sessionInUse() { return sessionInUse_; }
  NABoolean volatileSchemaInUse();

  void setSessionInUse(NABoolean v) { sessionInUse_ = v; };
  void setVolatileSchemaInUse(NABoolean v){ volatileSchemaInUse_ = v; };

  void disableVolatileSchemaInUse();
  void saveVolatileSchemaInUse();
  void restoreVolatileSchemaInUse();
  void setParentQid(const char *parentQid);
  const char *getParentQid() { return parentQid_; }

  inline Lng32 getNumSessions() { return numSessions_; }

private:
  NAHeap * heap_;

  NAString sessionID_;
  Lng32    numSessions_;
  Int32    databaseUserID_;
  NAString databaseUserName_;

  // On NSK we store a Guardian user name and the external LDAP
  // name. On other platforms the value of externalUserName_ is always
  // the same as databaseUserName_.
  NAString externalUserName_;

  NAString volatileSchemaName_;

  NAString volatileCatalogName_;

  Int64 segmentNum_;
  NAString segmentName_;

  NABoolean sessionInUse_;
  NABoolean volatileSchemaInUse_;

  NABoolean vsiuWasSaved_;
  NABoolean savedVSIU_;
  char *parentQid_;

  // Private method to retrieve user information from CLI and store a
  // copy in the databaseUserID_ and databaseUserName_ members. The
  // return value is a SQLCODE. When a value other than zero is
  // returned, error information is written into CmpCommon::diags().
  Lng32 getUserInfoFromCLI();
};




#endif // CMPSQLSESSION_H